GoliathDevelopersGet an API key
Reference/Coveragegenerated from the gateway manifest

getCoverageAvailability

Whether each named signal type.

POST/api/v1/callREADreadruns as the key's owner
View as Markdown

Whether each named signal type (a property signal type, e.g. FORECLOSURE or TAX_DELINQUENT) is live across your organization's counties (its markets): LIVE, BUILDING, REQUESTED, NOT_REQUESTED (nobody asked yet) or NO_PRODUCT (we have no coverage for that type). Per type liveCounties of totalCounties, each county's own status, and promised (every county not live holds a promised request: nothing to ask).

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "operationId": "getCoverageAvailability",
    "variables": {
      "signalTypes": [
        "<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.coverage.getCoverageAvailability({
  signalTypes: [
    '<String>'
  ]
})
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',
  },
  body: JSON.stringify({
    operationId: 'getCoverageAvailability',
    variables: {
      signalTypes: [
        '<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.

signalTypes[String!]!required

Response

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

response shape
{
  "data": {
    "coverageQuery": {
      "availability": [
        {
          "signalType": "…",
          "family": "…",
          "status": "LIVE",
          "promised": true,
          "liveCounties": 0,
          "totalCounties": 0,
          "counties": [
            {
              "countyFips": "…",
              "countyName": "…",
              "stateAbbr": "…",
              "status": "LIVE"
            }
          ]
        }
      ]
    }
  }
}

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.

Behaviour

A read. It rejects an Idempotency-Key header with 400 bad_request.

READgetCoverageCells