Ports
List ports
Section titled “List ports”curl https://api.firmsapi.com/v1/ports -H "x-api-key: $FIRMSAPI_KEY"{ "data": [ { "code": "4601", "name": "Newark/Elizabeth", "state": "NJ", "region": "2", "facility_count": 812, "active_count": 431 } ], "meta": { "count": 481, "...": "..." }}facility_count includes deleted codes and placeholders; active_count counts active, real facilities. name is
null for ports without a published name.
Get a port
Section titled “Get a port”curl -G https://api.firmsapi.com/v1/ports/4601 -H "x-api-key: $FIRMSAPI_KEY" -d type=04 -d limit=100Returns the port summary plus facilities, one page of the port’s facilities ordered by code. Placeholders are
left out.
| Parameter | Default | |
|---|---|---|
type |
Facility type codes, comma-separated | |
include_deleted |
false |
Include deleted codes |
limit |
100 |
1 to 500 |
cursor |
meta.next_cursor from the previous page |
A port with no FIRMS codes returns 404 not_found. Each page is one call.