Endpoint reference

Shared conventions

The base is https://api.datatactical.group and every path starts /v2. Authenticate with an API key as a bearer token (authentication). Identifiers are strings: FIPS codes zero-padded (00 for the nation, 22 for a state, 22073 for a county), NAICS codes as published with range sectors under their first code, SOC codes with the hyphen, ownership as fed, state, local or private. Periods are 2015 or 2015q1, chosen with granularity (annual or quarterly) and a from and to.

Parameters are strict: an unknown query parameter is a 400 with the code unknown_parameter, a repeated one repeated_parameter, and the parameters that shape a spreadsheet export are refused on a JSON or CSV request with xlsx_only_parameter. The data endpoints and the taxonomies answer an envelope of data and meta; on the data endpoints meta carries the vintage, the provenance_boundaries and the pagination block. The vintage list and the account routes answer the shapes their own pages describe.

Large results are paged with cursor and limit (paging). Every refusal is a problem document with a code (errors), and the request ceilings and the points meter are on rate limits.

The resources

Each page below lists its endpoints with every parameter, request field, response field and the problem codes each can send. The pages are generated from the API’s OpenAPI document, the same document the API serves at /v2/openapi.json, so a change to the API changes this reference on the next build.