get/v1/ports

Points of entry for a destination

Operation: listPorts
Authentication: API key

The airports, seaports and land borders the destination’s own application form accepts, flattened with a `type` on each entry. Read from the government portal and carrying the capture it came from — a port list with no date on it is a list nobody can tell is stale. Ethiopia is landlocked, so its `ports` never contain a seaport; that is a fact about the country and not a missing capture.

Request

Parameters

destination_iso3queryrequiredstring

typequerystring

Responses

200Every port the destination accepts, or the ones of the requested type.

destination_iso3stringrequired

one of: ETHSOMDJIKEN

countrystringrequired

sourcestringrequired

updatedstringnullrequired

landlockedbooleanrequired

portsPort[]required

next_cursorstringnullrequired

400The request body or query failed validation.

errorobjectrequired

401No key, an unknown key, a revoked key, or a key whose tenant is not active. All four return an identical body on purpose: distinguishing them would let a caller discover which partners we have.

errorobjectrequired

403The key is valid but does not hold the scope this route requires.

errorobjectrequired

404Not found, or not yours. A resource belonging to another tenant answers 404 rather than 403, because 403 would confirm the record exists.

errorobjectrequired

Example

curl

curl -X GET https://api.haavisa.com/v1/ports \
  -H "Authorization: Bearer $HAAVISA_API_KEY"?destination_iso3=<destination_iso3>

More in Reference

Something unclear? The eligibility guide explains the model behind the answers; the errors guide covers the envelope.