Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

The Companies API locations API

The locations API from The Companies API — 5 operation(s) for locations.

The Companies API locations API is one of 12 APIs that The Companies API publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include locations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 5 operations across 5 paths, and defines 6 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against a single base URL, https://api.thecompaniesapi.com.

5 operations 5 paths 6 schemas 5 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Base URL
https://api.thecompaniesapi.com/v2
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

The Companies API locations API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (apiKey).

  • apiKey — The API key to use for authentication, you can get it from your API tokens page.

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 5 GET. Each is listed below with its method, path, parameters, and response codes.

locations 5
GET
/v2/locations/cities
Search cities.
searchCities 6 params → 200401
GET
/v2/locations/counties
Search counties.
searchCounties 5 params → 200401
GET
/v2/locations/countries
Search countries.
searchCountries 6 params → 200401
GET
/v2/locations/states
Search states.
searchStates 5 params → 200401
GET
/v2/locations/continents
Search continents.
searchContinents 5 params → 200401

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are NominatimCountry (18 properties), NominatimContinent (16 properties), NominatimCity (14 properties), NominatimState (13 properties). Each schema is shown below with its type and property counts.

NominatimCounty
object
A county from the Nominatim API.
13 properties 8 required
PaginationMeta
object
Metadata about a paginated or billed response.
9 properties 8 required
NominatimCountry
object
A country from the Nominatim API.
18 properties 16 required
NominatimState
object
A state from the Nominatim API.
13 properties 9 required
NominatimContinent
object
A continent from the Nominatim API.
16 properties 14 required
NominatimCity
object
A city from the Nominatim API.
14 properties 8 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

thecompaniesapi-locations-api-openapi.yml Raw ↑

Other APIs The Companies API publishes across the network.

The Companies API actions API
The Companies API analytics API
The Companies API companies API
The Companies API industries API
The Companies API job-titles API
The Companies API lists API
The Companies API prompts API
The Companies API teams API
The Companies API technologies API
The Companies API users API
The Companies API utilities API