Lookups API

< Prev Next >

Retrieve available options and labels for coded fields

Explanation

Data Axle offers three mechanisms for working with lookups:

Lookup Mechanism	Description
Lookup Search API	Query lookups by label and value.
Lookup Download API	Download and cache all Data Axle lookup tables
Inline Labels	Access `value:label` mappings alongside records

GET /v1/lookups/:collection_name?q=query+string

Search a lookup table by label or value using the Lookup Search API.

View Available Tables for a full list of :collection_name values.

GET /v1/lookups/:collection_name/download

Download an entire lookup table with the Lookup Download API:

View Available Tables for a full list of :collection_name values.

The Download API supports ETags. Use ETags to poll the API frequently and receive results only when data changes.

An initial request returns ETag headers:

Note the 304 (Not Modified) response with an empty body.

To enable Inline Labels in API responses, add the include_labels=true option to any Data Axle API that returns document records:

A "labels" field is added to each document in the response:

The ?include_labels=true feature is available on the following APIs:

Requests to Lookup Search API and Lookup Download API support the following values for :collection_name.