location
Carrier Search By Location
endpoint: /api/v1/carrier/search/bylocation/geographic
method: POST
description: Returns a list of carriers that are physically located near the given location. Supports a wide plethora of optional search filters.
⚠️ Filters are contained in the body of the POST request. See Search Filter documentation.
| Query Parameter | Data Type | Descripton | Example |
| olat | string | Origin Latitude | olat=35.0843859 |
| olng | string | Origin Longitude | olng=-106.650422 |
| radius | string | The search radius in miles (0-300) | radius=150 |
| page (optional) | string | The page number of search results. Each page returns a list of 25 carrier objects. This parameter defaults to 1. | page=1 page=2 etc... |
| type (optional) | string | The format of the returned data. This parameter defaults to JSON format. | type=json type=xml |
usage:
Query by Location:
(POST) https://dashboard.ecarriercheck.com/api/v1/carrier/search/bylocation/geographic?radius=150&olat=35.0843859&olng=-106.650422
Return Types
Data can be returned as either JSON (Default) or xml. To explicitly specify the returned data type, add the type parameter to your query:
Query returning JSON:
(POST) https://dashboard.ecarriercheck.com/api/v1/carrier/search/bylocation/geographic?radius=150&olat=35.0843859&olng=-106.650422&type=json
Query returning XML:
(POST) https://dashboard.ecarriercheck.com/api/v1/carrier/search/bylocation/geographic?radius=150&olat=35.0843859&olng=-106.650422&type=xml