Getting started

Basics

• Base URL: https://<api-host>, provided with your key. Every data route starts with /v1.
• Authentication: an X-Intel-Key: <key> header, or Authorization: Bearer <key>.
• Format: JSON. Dates are YYYY-MM-DD; timestamps are ISO 8601 in UTC.
• OpenAPI spec: GET /openapi.json

To get an API key and your host, email andre@indax.co.

A key looks like ik_<key_id>_<secret> and is shown once, when Indax issues it. Keep it in an environment variable and never put it in a URL.

First call

Search for chemical Sites in Ohio:

curl -s -H "X-Intel-Key: $INTEL_KEY" \
  "https://<api-host>/v1/search?q=chemical&state=OH&label=site&limit=3"

{
  "items": [
    {
      "id": "site_17dab45d8a35524c80b9547163377c2f",
      "label": "site",
      "name": "Master Chemical Corporation d/b/a Master Fluid Solutions",
      "href": "/v1/sites/site_17dab45d8a35524c80b9547163377c2f",
      "summary": {
        "naics_primary": "324191",
        "operating_status": "unknown",
        "address": { "city": "Perrysburg", "state": "OH" }
      }
    }
  ],
  "next_cursor": "eyJ2IjoxLCJvIjozfQ"
}

Errors

Errors return JSON with a detail field that says what went wrong. To trace a call, send an X-Request-Id header; the API returns it as x-request-id.