GoliathDevelopersGet an API key
Reference/Propertiesgenerated from the gateway manifest

requestCoverage

Ask for coverage of places.

POST/api/v1/callWRITEidempotent · 24 hruns as the key's owner
View as Markdown

Ask for coverage of places ("Cook County, IL"; a county keys to its cell, anything else comes back in gaps) for signals by name (signals, always sent: [] when asking by family), or families picked outright (FORECLOSURE, PREFORECLOSURE, PROBATE, PREPROBATE, TAX_DELINQUENCY, CODE_VIOLATION). For those six, read listMyCoverageRequests first: one already asked is not asked again. Any other signal (liens, evictions) is recorded and reaches sales, but no read returns it: ask it once and give no date. Any member.

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "operationId": "requestCoverage",
    "variables": {
      "locations": [
        "<String>"
      ],
      "signals": [
        "<String>"
      ]
    }
  }'
import { GoliathClient } from '@goliath-data/sdk'

const goliath = new GoliathClient({
  apiKey: process.env.GOLIATH_API_KEY!,
  baseUrl: 'https://server.goliathdata.com',
})

const result = await goliath.properties.requestCoverage(
  {
    locations: [
      '<String>'
    ],
    signals: [
      '<String>'
    ]
  },
  { idempotencyKey: crypto.randomUUID() },
)
const res = await fetch('https://server.goliathdata.com/api/v1/call', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.GOLIATH_API_KEY}`,
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({
    operationId: 'requestCoverage',
    variables: {
      locations: [
        '<String>'
      ],
      signals: [
        '<String>'
      ]
    }
  }),
})
const { data, errors } = await res.json()

Variables

The example sends only what the schema requires. Some operations also need one of several optional variables (one filter or another, say); the description above says which.

locations[String!]!required
signals[String!]!required
families[String!]

Response

What comes back under data: a list shows as one entry, and a value as its type.

response shape
{
  "data": {
    "coverageRequestMutation": {
      "requestCoverage": {
        "cells": [
          {
            "jurisdictionKey": "…",
            "family": "…",
            "created": true,
            "buildStatus": "…",
            "served": true
          }
        ],
        "gaps": [
          {
            "reason": "…",
            "values": [
              "…"
            ]
          }
        ]
      }
    }
  }
}

Errors

400unknown_variable

A variable the operation does not declare. A typo is refused rather than silently dropped.

401unauthorized

No bearer header, or the key is invalid or revoked.

403insufficient_scope

The key lacks the scope the operation requires.

403forbidden

A referenced record does not exist, was deleted, or is outside your organization. The gateway cannot tell those apart.

409idempotency_conflict

A request with this Idempotency-Key is still in flight.

Idempotency

Send an Idempotency-Key of 1 to 255 characters. A finished request retried with the same key replays its stored response, marked Idempotency-Replayed: true; one still in flight returns 409 idempotency_conflict. Keys expire after 24 hours. Write without fear →

READgetPropertyREADgetPropertySignalsREADgetPropertyOwnersREADfindPropertiesREADlistPropertyFiltersREADlistFilterFolders