v1

latestOpenAPI 3.0.32026-07-23273969.2 KB

Search facilities by name, address, zip code, city/state, website domain, or coordinates

Unified facility search. Provide at least one of: non-empty name, non-empty address, zip_code, non-empty website_domain, or both city and state (then use radius around the geocoded point). You may also pass location as latitude,longitude for radius search instead of city/state. Optionally include lane data per facility with include_lanes=true. Lanes can be filtered by min_distance (miles from facility) and direction (compass direction). Filters are applied before the top_n limit.

Pagination

When results exceed 100 facilities, the response is paginated using opaque cursor-based pagination. The Link response header contains a next-page URL with a cursor parameter. Follow that URL to retrieve subsequent pages. The X-Total-Count header shows the total matching facilities across all pages. Pagination is not supported with smart_search=true. See component schema FacilitiesQueryCriteria for the full parameter model and validation shape. Historical path /find_facilities exposes the same search behavior and is documented here as /facilities for a single contract.

get/facilities

Query parameters

namestring

Facility or collection name (optional if address, both city and state, or website_domain are provided). See FacilitiesQueryCriteria for validation rules.

addressstring

Substring match on formatted address (optional if name, both city and state, or website_domain are provided).

citystring

City; use with state for geocoded radius search unless name, address, or website_domain alone is sufficient.

statestring

State; use with city unless name, address, or website_domain supplies the search mode.

website_domainstring

Substring match against the shipper's contact_url. Must include the TLD (e.g. acme.com). Optional path tails (acme.com/about) are accepted by the validator but the path is stripped before matching — only the host is searched.

Mutually exclusive with name and address. If name or address is also supplied, website_domain is silently ignored (see FacilitiesQueryCriteriaFilter precedence). Also ignored when smart_search=true is used together with name.

locationstring

Comma-separated latitude,longitude; radius applies around this point when provided instead of city/state.

radiusnumber

Search radius in miles around the geocoded city/state point or location

lot_size_categorystring

Lot size category filter

limitinteger

Maximum number of facilities to return

facility_typestring

Optional place category filter (pipe-separated values accepted by the service)

intermodal_drayagestring

Optional intermodal drayage filter flag

include_lanesboolean

Include inbound and outbound lane data for each facility. Lanes are ranked by weight.

top_ninteger

Number of top lanes to return per direction (inbound/outbound) per facility.

min_distancenumber

Minimum distance in miles from the facility to a lane destination. Lanes closer than this distance are excluded. Applied before top_n.

direction'N' | 'S' | 'E' | 'W' | 'NE' | 'NW' | 'SE' | 'SW'

Filter lanes by compass direction from the facility. Applied before top_n.

zip_codestring

US zip code; searches facilities near the zip centroid.

cursorstring

Opaque pagination cursor from the Link header of a previous response. When results exceed 100 facilities, the server returns a Link header containing a next-page URL with this cursor embedded. Follow that URL to retrieve subsequent pages. Do not construct or parse this value — it is server-controlled and opaque.

Headers

acceptstring required

application/json

Access-Tokenstring required

Access Token for authentication

x-api-keystring required

X api key for authentication

Response

List of facilities

contact_phonestring nullable
contact_urlstring nullable
facility_namestring required
formatted_addressstring required
idstring required
latnumber required
lonnumber required
operating_hoursstring nullable
place_categorystring required
equipment_pairingsstring[] nullable

Equipment types paired with this facility based on observed carrier activity. Values are Title Case display strings (e.g. "Dry Van", "Box Truck", "Reefer"). Empty array when no pairing data is available.