Finding records

Use /v1/search when you know a name, an area or an industry. Use /v1/resolve when you hold an identifier, such as a permit number or an EIN.

Search: GET /v1/search

Filters combine with AND, and at least one is required. Each result carries a summary (NAICS, address, operating status, project status, first and last event dates), so you can sort results without opening each record.

GET /v1/search?naics=325&state=LA&label=site&limit=3

{
  "items": [
    {
      "id": "site_00981889b6ef513fb9b74d89ad76fa49",
      "label": "site",
      "name": "C-4 CENTRAL PRODUCTION FACILITY",
      "summary": { "naics_primary": "325991", "operating_status": "operating" }
    },
    { "id": "site_009da9a649db56e1bfa7250bf483b981", "name": "VIRDIA B2X LLC - RACELAND PLANT" }
  ],
  "next_cursor": "eyJ2IjoxLCJvIjozfQ"
}

Paging

/search, /edges and /timeline return next_cursor. Pass it back as cursor with the same filters until it is null. Paging stops at 10,000 results, so narrow large queries with state, a longer naics prefix or a radius.

Resolve: GET /v1/resolve

Pass kind and key. Dashes, case and padding in the key do not matter. If the record was merged, you get the surviving ID, and redirected_from names the old one.

The full list of kind values is in GET /openapi.json.

GET /v1/resolve?kind=permit&key=US-AL-01:210-0005

{ "kind": "permit", "id": "pmt_a3faf0a577d054b48056180d19adb9fe", "label": "permit", "redirected_from": null }

A key no record holds returns 404 {"detail": "no entity holds this key"}.