> ## Knowledge Base Index
> Fetch the complete knowledge base index at: https://help.wiremo.co/sitemap.xml
> Use this file to discover available pages before exploring further.
> Pure-Markdown content can be obtained by appending a '.md' suffix to the content URLs listed in the sitemap (without the trailing slash).

# How to create GTrack API KEY

# How to Create an API Key in GTrack
Follow these steps to generate a **GTrack API key** for programmatic access.

| 🔑 The GTrack API Key is available only for **Business and Pro plans**. It is not available on the **Starter or Advanced plans**.

### **Step 1: Open API Management**
1. Log in to your **GTrack Dashboard**.
2. Click on your profile name (top right corner).
3. From the dropdown, select **API Management** under **Application Settings**. 

![](https://storage.crisp.chat/users/helpdesk/website/-/7/f/2/f/7f2f2b9a81bb9000/xnip2025-10-2309-31-02_14apu52.png =300x546)

### **Step 2: Create a New API Key**
Once you’re in the **API Key Management** section:
1. Click the **Create New API Key** button.
2. A popup will appear for adding the key details.

In the **Create New API Key** window:
1. Enter a **Name** for your API key (for example: `Gtrack API`).
2. Optionally, add a **Description** to clarify its use.
3. (Optional) Restrict access by entering specific **Allowed IPs** or leave it open to all.
4. Click **Create API Key**.

![](https://storage.crisp.chat/users/helpdesk/website/-/7/f/2/f/7f2f2b9a81bb9000/xnip2025-10-2309-36-34_1g15j4m.png =1024x443)

### **Step 3: Copy and Save Your API Key**
After clicking **Create API Key**, GTrack will generate your new key and display it once.
1. Click the **Copy** button to copy your API key.
2. **Save this key securely** — for example, in a password manager or your secrets vault.
3. Once you close this window, **you won’t be able to view the key again**.
4. If lost, you’ll need to **create a new API key**.

![](https://storage.crisp.chat/users/helpdesk/website/-/7/f/2/f/7f2f2b9a81bb9000/xnip2025-10-2309-39-11_1ddt0nx.png =1024x541)

| ⚠️ Note: API Key Scopes (Permissions)

Each API key has specific scopes managed by GTrack:
* **Read** – Allows fetching scan results and business data.
* **Write** – Allows creating new scans.
* Permissions are managed by GTrack and cannot be changed by users.
* To request elevated access (e.g., enabling **"write"**), contact GTrack Support via live chat.


![](https://storage.crisp.chat/users/helpdesk/website/-/7/f/2/f/7f2f2b9a81bb9000/xnip2025-10-2309-41-03_mfwyun.png =1024xauto)

### **Step 4: Open the API Documentation**
After creating and saving your key, click on the **Documentation** link at the top of the **API Key Management** window.
This will open the **GTrack API Documentation** page.

![](https://storage.crisp.chat/users/helpdesk/website/-/7/f/2/f/7f2f2b9a81bb9000/xnip2025-10-2309-43-11_hjabgs.png =1024x348)

### **Step 5: Review Base URLs and Authentication**

After opening the **API Documentation**, you’ll find the base URLs and authentication requirements for all API endpoints.

#### **Base URLs**
* **API URL:** `https://gtrack-api.wiremo.co`
* **MCP URL (Map Control Panel):** `https://gtrack-mcp.wiremo.co/?key=gtrk_live_XXXXXXXXXXXXXXXXXXXX`
The MCP URL allows quick access to scan data via a browser by appending your API key directly to the query parameter.

#### **Authentication**
* All API requests require an API key for authorization.  
* Include it in the request header: `x-api-key: gtrk_live_your_api_key_here`

#### **API Rate Limits**
* GTrack enforces rate limits to ensure fair and stable API usage. Each plan allows a specific number of read and write requests per hour. 
* When you reach the limit, the API returns an **HTTP 429 (Too Many Requests)** error.

#### **Rate Limit Headers**
Each API response includes headers that help you track your current usage:

* `X-RateLimit-Limit` — total number of allowed requests per hour
* `X-RateLimit-Remaining` — how many requests you can still make before reaching the limit
* `X-RateLimit-Reset` — time (in seconds) until your rate limit resets
If your app exceeds the limit, the API will return: HTTP 429 Too Many Requests

You’ll need to wait until the rate limit resets before sending additional requests.

![](https://storage.crisp.chat/users/helpdesk/website/-/7/f/2/f/7f2f2b9a81bb9000/xnip2025-10-2310-02-52_1hycczc.png =1024x348)

### Step 6: Using API Endpoints from the Documentation 

In the **GTrack API Documentation**, you’ll find multiple ready-to-use endpoints that allow you to interact with your account data: such as retrieving tracked businesses, creating scans, or fetching analytics.

Each API section includes:
* The HTTP method (`GET`, `POST`, etc.)
* The full endpoint path
* Example code snippets (cURL, Python, Node, PHP, React)
* Required headers (`x-api-key`, `Content-Type`)
* Example success and error responses

This allows you to copy and test any request directly in your terminal or application.

#### **Example: Get All Tracked Businesses**

Use this endpoint to retrieve all tracked businesses associated with your authenticated account.

![](https://storage.crisp.chat/users/helpdesk/website/-/7/f/2/f/7f2f2b9a81bb9000/xnip2025-10-2310-03-40_9egkt2.png =1024x248)

**Endpoint:**  
`GET /api/tracked-businesses`

**Example with cURL (macOS Terminal):**

```bash
curl -X GET https://gtrack-api.wiremo.co/api/tracked-businesses \
  -H "x-api-key: gtrk_live_your_api_key_here" \
  -H "Content-Type: application/json"
```

![](https://storage.crisp.chat/users/helpdesk/website/-/7/f/2/f/7f2f2b9a81bb9000/xnip2025-10-2310-09-30_wzyau2.png =1024x851)

### **Step 7: Understanding API Responses**

You can find full examples of successful and error responses directly inside the **GTrack API Documentation**.  
Each endpoint includes real examples showing how data is returned, including status codes, response formats, and possible errors such as missing permissions or invalid parameters.
Use these examples to understand how your application should handle responses and to troubleshoot any API issues quickly.

### **That’s it!**
You’ve learned how to:
* Create and manage your API key in GTrack  
* Access the official API documentation  
* Use the provided endpoints to interact with your account data  
* Retrieve information like tracked businesses via API  

For further integration and advanced API usage, refer to the full [**GTrack API Documentation**](https://gtrack.wiremo.co/documentation-api).