API Reference

Get locodes

get
https://{stage}.api.southpole.com/calculations/v1/locations/locodes

Scopes: calculate-api

This endpoint allows users to find locodes

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

UN/LOCODE search query

string

UN/LOCODE value

string

ISO 3166-1 alpha-2 country code

functions
array of objects

Functions of locodes to include in the query. All locode functions will be returned if not specified.

functions
queryFields
array of objects

Fields to query by

queryFields
sort
array of objects

Field to sort results by.

sort
number
1 to 100
Defaults to 20

Number of locodes to return per page

number
Defaults to 1

Page number to retrieve locodes for

Responses

Updated 7 months ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago