Getting started
Introduction
How trade and transport locations are coded, and how to use the codes in your own work and software.
These guides explain the codes behind waykite: what a location code says and what it does not, the functions and statuses each location carries, how they relate to airport and terminal codes, and how new codes come about.
Authentication
- API keys: creating, sending and replacing your organization's keys.
- Workload identity: calling the API from CI and cloud workloads without storing a key.
Location codes
- Location codes explained: what the five characters of a code mean, and what a code does and does not identify.
- Function codes: what a location handles, from ports and airports to border crossings, and how to filter by it.
- Status codes: who approved a location's entry, or how far it has been checked.
- UN/LOCODE vs IATA vs ICAO: three kinds of location code and what each covers.
- Terminal codes: how container terminals are identified within a port.
- How new codes are assigned: who adds a location code, and when it becomes usable.
Building with the data
The API reference covers the REST API: searching locations and terminals, looking them up by code and finding the nearest. The UI components add a location or terminal picker, and the controls around it, to your app.