RESTful APIs

Places Introduction

Contents

A Place is a collection of data about a location—ranging from mapping location information, such as its name, address and GPS coordinates, to details about its amenities, truck entrances and exits, parking, hours of operation, and more.

Trimble Maps maintains an ever-growing Places database that includes millions of commercial locations across North America that serve the transportation industry. These Places range from distribution centers and manufacturing facilities to truck stops and rest areas.

The Places API allows you to request all of the location data for a Place. You can also add your own custom attributes to a Place, including:

  • A customPlaceId to match your existing ID for the location, making it easy to call that location’s information in the future.
  • Notes for the driver about the Place.
  • Operating hours for the Place.
  • Contact information for the Place.
Watch Video

What Can You Do?

The Places API can be used in any application that requires accurate location information to provide exceptional customer service. For PC*Miler route planning and CoPilot navigation, for example, Places can provide details drivers need for accurate final-mile routing to locations with specific rules for commercial vehicles.

Getting Started

To gain access to the Places API, you must be a Premium Web Services subscriber. If you are not a subscriber, please contact your Trimble Maps representative or our Sales team for more information.

Resource URL

https://api.trimblemaps.com/places/v1

What is a trimblePlaceId?

Every location in our Places database is identified by a trimblePlaceId. That ID ensures you receive the exact same information about a Place—address, contact information, etc.—regardless of whether you are calling the information from your transportation management system (TMS) or accounting software.

For APIs that require a generic placeId parameter, you can use one of two values:

  • The trimblePlaceId. This is a string value assigned by Trimble Maps that cannot be changed or deleted.

  • A customPlaceId that you have assigned to the Place. This string value is in addition to the TrimblePlaceId. It can be a more “human readable” value, such as your company’s existing shortcode for the location.

What’s in a Place?

A Place may include all of the following information.

Field Description Data Type
trimblePlaceId The unique Trimble Maps identifier for the Place. 
string
customPlaceId Your company’s own identifier (shortcode) for the Place. 
string
name The name of the Place. 
string
categoryName The category for the Place in the Places database. 
string
address The street address of the Place. 
object
formattedAddress The address as a single text string. 
string
geometry The coordinates of the Place. 
GeoJSON Point Format
site The details of the Site that surrounds the perimeter of a Place. A Site is a geofence on the map that defines an area such as a warehouse, a shopping mall or a business park. It includes site-specific details such as gates where commercial vehicles need to enter or exit. 
object
facilityInformation The fuel services, repair services, parking, and amenities available at the Place. 
object
operatingHours The hours of operation at the Place. 
object
contactInfo The Place’s phone number and web site URL. 
object
lastModified The last modified date & time for the Place. 
string

Sample JSON for a Place 

{
  "trimblePlaceId": "0xlM0l28x0LEiCiOPrHt-_WQ",
  "customPlaceId": null,
  "name": "Pilot Dealer #879",
  "categoryName": "Truck Stop",
  "address": {
    "streetAddress": "2828 El Centro Rd",
    "extendedAddress": null,
    "streetNumber": null,
    "city": "Sacramento",
    "county": null,
    "state": {
      "name": "California",
      "abbrv": "CA"
    },
    "country": {
      "name": "United States",
      "abbrv": "US"
    },
    "postalCode": "95833"
  },
  "formattedAddress": "2828 El Centro Rd, Sacramento, CA 95833",
  "geometry": {
    "type": "Point",
    "coordinates": [-121.53838, 38.617049]
  },
  "site": {
    "id": 1505649372,
    "name": "Pilot Dealer #879",
    "type": "",
    "gates": [
      {
        "id": 1500723790,
        "type": "Two Way",
        "vehAllowed": ["Auto", "Truck"],
        "gateToSite": {
          "geometry": {
            "type": "Point",
            "coordinates": [-121.538901829157, 38.6165939649754]
          }
        },
        "gateToRoad": {
          "geometry": {
            "type": "Point",
            "coordinates": [-121.538902, 38.616594]
          }
        }
      },
      {
        "id": 1500723791,
        "type": "Two Way",
        "vehAllowed": ["Auto"],
        "gateToSite": {
          "geometry": {
            "type": "Point",
            "coordinates": [-121.539214926651, 38.6174163677263]
          }
        },
        "gateToRoad": {
          "geometry": {
            "type": "Point",
            "coordinates": [-121.539215, 38.617416]
          }
        }
      },
      {
        "id": 1500723792,
        "type": "Exit",
        "vehAllowed": ["Truck"],
        "gateToSite": {
          "geometry": {
            "type": "Point",
            "coordinates": [-121.539143957885, 38.6181469285456]
          }
        },
        "gateToRoad": {
          "geometry": {
            "type": "Point",
            "coordinates": [-121.539144, 38.618147]
          }
        }
      },
      {
        "id": 1500723789,
        "type": "Two Way",
        "vehAllowed": ["Auto", "Truck"],
        "gateToSite": {
          "geometry": {
            "type": "Point",
            "coordinates": [-121.539110560819, 38.6169404595354]
          }
        },
        "gateToRoad": {
          "geometry": {
            "type": "Point",
            "coordinates": [-121.539111, 38.61694]
          }
        }
      }
    ],
    "geometry": {
      "type": "MultiPolygon",
      "coordinates": [
        [
          [
            [-121.539302593949, 38.6180968329465],
            [-121.539277546149, 38.6181886748781],
            [-121.539198228118, 38.6182262465774],
            [-121.537048291992, 38.6182387704771],
            [-121.536985672493, 38.6182596436434],
            [-121.536931402261, 38.618384882641],
            [-121.536931402261, 38.6185518679711],
            [-121.536860433496, 38.6185894396704],
            [-121.534798164669, 38.6185685665041],
            [-121.534247113079, 38.6185727411374],
            [-121.534075953116, 38.6168653161369],
            [-121.534710497371, 38.6167400771393],
            [-121.53508203973, 38.6167066800732],
            [-121.537336341687, 38.616406106479],
            [-121.537628566014, 38.616439503545],
            [-121.538394645283, 38.6165079569019],
            [-121.539112648136, 38.6165939649754],
            [-121.539256672983, 38.6166106635084],
            [-121.539302593949, 38.6180968329465]
          ]
        ]
      ]
    },
    "lastModified": "2020-04-01T23:01:19.436Z"
  },
  "operatingHours": {
    "sunday": {
      "hours": [
        {
          "open": "0000",
          "close": "2400"
        }
      ],
      "formattedText": "Sunday:  Open 24 hr"
    },
    "monday": {
      "hours": [
        {
          "open": "0000",
          "close": "2400"
        }
      ],
      "formattedText": "Monday:  Open 24 hr"
    },
    "tuesday": {
      "hours": [
        {
          "open": "0000",
          "close": "2400"
        }
      ],
      "formattedText": "Tuesday:  Open 24 hr"
    },
    "wednesday": {
      "hours": [
        {
          "open": "0000",
          "close": "2400"
        }
      ],
      "formattedText": "Wednesday:  Open 24 hr"
    },
    "thursday": {
      "hours": [
        {
          "open": "0000",
          "close": "2400"
        }
      ],
      "formattedText": "Thursday:  Open 24 hr"
    },
    "friday": {
      "hours": [
        {
          "open": "0000",
          "close": "2400"
        }
      ],
      "formattedText": "Friday:  Open 24 hr"
    },
    "saturday": {
      "hours": [
        {
          "open": "0000",
          "close": "2400"
        }
      ],
      "formattedText": "Saturday:  Open 24 hr"
    }
  },
  "contactInfo": {
    "phone": "9169274774",
    "url": null
  },
  "facilityInformation": {
    "fuel": ["bulkPropane", "propane", "ulsd", "def"],
    "repairServices": ["truckRepair", "tireService", "roadsideAssistance"],
    "amenities": [
      "wifi",
      "restrooms",
      "showers",
      "tripPak",
      "truckWash",
      "scale",
      "rvDump",
      "convenienceStore",
      "mailingServices",
      "laundry",
      "24hourOpen",
      "transflo",
      "restaurant",
      "atm",
      "hotelNearby",
      "moneyServices"
    ],
    "parkingInformation": {
      "truckParkingSpaces": 275,
      "types": ["10hourParking"]
    }
  },
  "lastModified": "2020-04-01T23:01:19.436Z"
}

How to Use the Places API?

See the How to Use Places page for the most common uses of the Places API.

Last updated June 7, 2024.
API Endpoint:
AWS Azure
Contents