Getting Started

The GMGPS Open API allows everyone to build apps on the GMGPS platform. The API is organized around REST, and every response (including errors) is returned as JSON.

Let's walk through the core API concepts as we tackle some everyday use cases.

API Request

Making a request to the GMGPS API is straightforward. The quickest way to try it is with a tool such as Postman.

If you'd rather use the command line, cURL works too:

curl --request GET \
  --url https://gateway.gmgps.com.my \
  --header 'Authorization: Bearer gmgps_live_<key>'

Authenticated Request

Every authenticated request must include an API key as a Bearer token:

Authorization: Bearer gmgps_live_<key>

Authentication

GMGPS Open API authenticates requests with a Personal Access Token. Each key has the format gmgps_live_<key> and is sent as a Bearer token.

Personal Access Token

1. From the user menu (top-right), open API Settings (available to account owners).
2. Click Create API Key.
3. Enter a name for the key, then click Create.
4. The key appears in the list — click the copy icon next to it to copy the value.

⚠️ Warning: Store the key securely and don't share it. You can regenerate or revoke a key at any time from API Settings.

API Response

All GMGPS API endpoints return JSON.

Content-Type: application/json

Rate Limiting

Every API key has a rate limit measured in requests per hour. The default is 300 calls per hour, though the actual limit depends on what your account manager has configured for your account. You can check your limit and current usage on the API Settings page.

When the limit is exceeded, the API responds with 429 Rate limit exceeded.

Data Format