Skip to main content

Taxonomies (regions, sectors, brands, industries)

Maps to: taxonomies

Before you can run a query you need the identifiers it references — region codes, sector IDs, brand IDs, and the UUIDs of custom sectors and industries. The taxonomy endpoints are how you discover them. See Regions, sectors & brands for the concepts.

Regions​

GET /v1/taxonomies/regions

Lists the regions available to your account. Pass ?all=true to list every region rather than just yours. Returns region codes (e.g. us, uk) used everywhere else.

Sectors​

GET /v1/taxonomies/regions/{region}/sectors
GET /v1/taxonomies/regions/{region}/sector/{sector_id}
  • The first lists all sectors in a region.
  • The second describes a single sector.

Brands​

GET /v1/taxonomies/regions/{region}/sectors/{sector_id}/brands

Lists the brands within a sector, with their brand_ids.

Guess a brand's sector​

GET /v1/taxonomies/regions/{region}/guess_sector_for/{brand_id}

Given a brand, suggests the sector it belongs to in that region — handy when you have a brand but not its sector.

GET /v1/taxonomies/search/{type}?q={query}&region={region}&min_similarity={n}

Searches for entities of a given type matching q. min_similarity (0–1, where 1.0 is an exact match) tunes how fuzzy the match may be.

Custom sectors​

GET /v1/taxonomies/custom-sectors
GET /v1/taxonomies/regions/{region}/custom-sectors
GET /v1/taxonomies/custom-sectors/{uuid}

List your custom sectors (optionally by region), or fetch one by UUID. Use the custom_sector_uuid in an entity — see Custom sectors & industries.

Industry trees​

GET /v1/taxonomies/industries/trees/{region}
GET /v1/taxonomies/industries/trees/{region}/{uuid}

List the industry trees in a region, or fetch a single tree by its root UUID. Use the industry_uuid in an entity.