For the complete documentation index, see llms.txt. This page is also available as Markdown.

Pricing Locations

List Pricing Locations

get

Get a list of pricing locations with optional filtering by ISOs, zones, zone types and a search term.

Args: params: Query parameters for filtering pricing locations sort_column: Column to sort by. sort_order: Sort order - 'asc' or 'desc'.

Query parameters
sort_columnany ofOptional
stringOptional
or
nullOptional
sort_orderany ofOptional
string · enumOptionalPossible values:
or
nullOptional
api_keyany ofOptional

API key for authentication (query)

stringOptional
or
nullOptional
searchany ofOptional

Optional search term to filter locations by name

stringOptional
or
nullOptional
isosany ofOptional

Comma-separated list of market IDs to filter by

stringOptional
or
nullOptional
zonesany ofOptional

Comma-separated list of zones to filter by

stringOptional
or
nullOptional
statusany ofOptional

Comma-separated list of statuses to filter by

stringOptional
or
nullOptional
location_typesany ofOptional

Comma-separated list of location types to filter by

stringOptional
or
nullOptional
has_geo_dataany ofOptional

Filter by whether locations have geographic data

booleanOptional
or
nullOptional
Header parameters
x-api-keyany ofOptional

API key for authentication (header)

stringOptional
or
nullOptional
Responses
200

Successful Response

application/json

Response from get_items_and_facets containing items, total count, and facets.

total_itemsintegerRequired
get
/pricing_locations

List Nearby Pricing Locations

get

Get a list of pricing locations near the provided latitude/longitude or gs_entity_id. User must provide either latitude and longitude or a gs_entity_id, but not both.

Query parameters
api_keyany ofOptional

API key for authentication (query)

stringOptional
or
nullOptional
limitinteger · min: 1 · max: 100OptionalDefault: 20
latitudeany ofOptional

The latitude of the location to search

number · min: -90 · max: 90Optional
or
nullOptional
longitudeany ofOptional

The longitude of the location to search

number · min: -180 · max: 180Optional
or
nullOptional
gs_entity_idany ofOptional

The GS entity ID of the location to search

stringOptional
or
nullOptional
Header parameters
x-api-keyany ofOptional

API key for authentication (header)

stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
gs_entity_idstringRequired
locationstringRequired
market_idstringRequired
distance_in_milesnumberRequired
get
/pricing_locations/nearby

Get Pricing Location

get

Get data for a specific pricing location by its ID.

Path parameters
gs_entity_idstringRequired

Name of the pricing location to query

Query parameters
api_keyany ofOptional

API key for authentication (query)

stringOptional
or
nullOptional
Header parameters
x-api-keyany ofOptional

API key for authentication (header)

stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
gs_entity_idstringRequired
locationstringRequired
location_typestringRequired
market_idstringRequired
baaany ofRequired
stringOptional
or
nullOptional
zoneany ofRequired
stringOptional
or
nullOptional
zone_typeany ofRequired
stringOptional
or
nullOptional
latitudeany ofRequired
numberOptional
or
nullOptional
longitudeany ofRequired
numberOptional
or
nullOptional
pricing_datasetsany ofOptional
string[]Optional
or
nullOptional
earliest_seen_utcany ofRequired
string · date-timeOptional
or
nullOptional
latest_seen_utcany ofRequired
string · date-timeOptional
or
nullOptional
status_threshold_daysany ofRequired
integerOptional
or
nullOptional
statusany ofRequired
stringOptional
or
nullOptional
get
/pricing_locations/{gs_entity_id}

Last updated

Was this helpful?