### **Authentication**

All requests must include an API key as a query parameter:

```
httpCopyEditsearchatlas_api_key=<your_api_key>
```

---

### **1. Create a Keyword Rank Tracking Project**

### **Endpoint:**

```
httpCopyEditPOST https://keyword.searchatlas.com/api/v1/rank-tracker/
```

### **Payload:**

```
jsonCopyEdit{ "url": "https://example.com/", "refresh_interval": 30, "country_code": "US", "language": "English", "precise_location": "United States", "name": "Example Project", "type": "domain" }
```

### **Response Example:**

```
jsonCopyEdit{ "project_id": "123456" }
```

---

### **2. Update Project Settings**

### **Endpoint:**

```
httpCopyEditPATCH https://keyword.searchatlas.com/api/v1/rank-tracker/#{{project_id}}/
```

### **Payload:**

```
jsonCopyEdit{ "url": "example.com", "refresh_interval": 7, "country_code": "US", "language": "English", "precise_location": "United States", "description": "Updated Project", "name": "Updated Example Project" }
```

---

### **3. List All Projects**

### **Endpoint:**

```
httpCopyEditGET https://keyword.searchatlas.com/api/v1/rank-tracker/
```

### **Response Example:**

```
jsonCopyEdit{ "results": [ { "project_id": "123456", "name": "Example Project", "url": "https://example.com/" } ] }
```

---

### **4. Add Keywords to Track**

### **Endpoint:**

```
httpCopyEditPUT https://keyword.searchatlas.com/api/v2/rank-tracker/#{{project_id}}/tracked-keywords/
```

### **Payload:**

```
jsonCopyEdit[ { "keyword": "example keyword", "location": "United States" }, { "keyword": "seo tracking", "location": "United States" } ]
```

---

### **5. Remove Tracked Keywords**

### **Endpoint:**

```
hCopyEditDELETE https://keyword.searchatlas.com/api/v2/rank-tracker/#{{project_id}}/tracked-keywords/
```

### **Payload:**

```
jsonCopyEdit[ { "keyword": "example keyword", "location": "United States" } ]
```

---

### **6. Get Keyword Ranking Details**

### **Endpoint:**

```
httpCopyEditGET https://keyword.searchatlas.com/api/v1/rank-tracker/#{{project_id}}/keywords-details/
```

### **Query Parameters:**

- `period2_start=YYYY-MM-DD`
- `period2_end=YYYY-MM-DD`
- `page=1`
- `page_size=10`
- `keyword_operator=contains`
- `position=1`
- `position_operator=greater_than`
- `location=United States`

### **Response Example:**

```
jsonCopyEdit{ "keywords": [ { "keyword": "example keyword", "position": 3, "url": "https://example.com/" } ] }
```

---

### **7. Refresh SERP Data**

### **Endpoint:**

```
httpCopyEditPOST https://keyword.searchatlas.com/api/v1/rank-tracker/#{{project_id}}/refresh/
```

---

### **8. Get Competitors List**

### **Endpoint:**

```
httpCopyEditGET https://keyword.searchatlas.com/api/v1/rank-tracker/#{{project_id}}/competitors-by-visibility/
```

### **Query Parameters:**

- `period2_start=YYYY-MM-DD`
- `period2_end=YYYY-MM-DD`
- `page=1`
- `page_size=10`

### **Response Example:**

```
jsonCopyEdit{ "competitors": [ { "domain": "competitor.com", "visibility_score": 85 } ] }
```

---

### **9. Remove a Rank Tracking Project**

### **Endpoint:**

```
httpCopyEditDELETE https://keyword.searchatlas.com/api/v1/rank-tracker/#{{project_id}}/
```

---

### **10. Get Historical Keyword Performance**

### **Endpoint:**

```
httpCopyEditGET https://keyword.searchatlas.com/api/v2/rank-tracker/#{{project_id}}/keyword-historical-performance/
```

### **Query Parameters:**

- `keyword=example`
- `location=United States`

### **Response Example:**

```
jsonCopyEdit{ "history": [ { "date": "2024-07-20", "position": 2 } ] }
```

---

### **Usage Flow**

1. **Create a Rank Tracking Project** → Get `project_id` from response.
2. **Add Keywords to Track** → Use the `project_id` to add keywords.
3. **Retrieve Keyword Rankings & Reports** → Fetch rankings, historical data, or competitor insights.
4. **Update or Delete Projects** → Modify settings or remove tracking.

---

## Postman Collection

```
{ "info": { "_postman_id": "12dbfc3a-03af-453a-84b3-6d7e3f39eb08", "name": "Keyword Rank Tracker API Copy", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "18279724" }, "item": [ { "name": "Add KRT Project", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "accept", "value": "application/json, text/plain, */*" }, { "key": "accept-language", "value": "en-US,en;q=0.9" }, { "key": "authorization", "value": "Bearer REDACTED-EXPIRED-EXAMPLE-TOKEN" }, { "key": "content-type", "value": "application/json" }, { "key": "origin", "value": "https://dashboard.linkgraph.com" }, { "key": "priority", "value": "u=1, i" }, { "key": "referer", "value": "https://dashboard.linkgraph.com/" }, { "key": "sec-ch-ua", "value": "\"Not/A)Brand\";v=\"8\", \"Chromium\";v=\"126\", \"Google Chrome\";v=\"126\"" }, { "key": "sec-ch-ua-mobile", "value": "?0" }, { "key": "sec-ch-ua-platform", "value": "\"macOS\"" }, { "key": "sec-fetch-dest", "value": "empty" }, { "key": "sec-fetch-mode", "value": "cors" }, { "key": "sec-fetch-site", "value": "cross-site" }, { "key": "user-agent", "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36" } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"https://linkgraph.io/\",\n \"refresh_interval\": 30,\n \"country_code\": \"US\",\n \"language\": \"English\",\n \"precise_location\": \"United States\",\n \"name\": \"Linkgraph \",\n \"type\": \"domain\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://keyword.searchatlas.com/api/v1/rank-tracker/?searchatlas_api_key=<your_api_key>", "protocol": "https", "host": [ "keyword", "searchatlas", "com" ], "path": [ "api", "v1", "rank-tracker", "" ], "query": [ { "key": "searchatlas_api_key", "value": "<your_api_key>" } ] } }, "response": [] }, { "name": "Update Project Setting", "request": { "auth": { "type": "noauth" }, "method": "PATCH", "header": [ { "key": "accept", "value": "application/json, text/plain, */*" }, { "key": "accept-language", "value": "en-US,en;q=0.9" }, { "key": "authorization", "value": "Bearer REDACTED-EXPIRED-EXAMPLE-TOKEN" }, { "key": "content-type", "value": "application/json" }, { "key": "origin", "value": "https://dashboard.linkgraph.com" }, { "key": "priority", "value": "u=1, i" }, { "key": "referer", "value": "https://dashboard.linkgraph.com/" }, { "key": "sec-ch-ua", "value": "\"Not/A)Brand\";v=\"8\", \"Chromium\";v=\"126\", \"Google Chrome\";v=\"126\"" }, { "key": "sec-ch-ua-mobile", "value": "?0" }, { "key": "sec-ch-ua-platform", "value": "\"macOS\"" }, { "key": "sec-fetch-dest", "value": "empty" }, { "key": "sec-fetch-mode", "value": "cors" }, { "key": "sec-fetch-site", "value": "cross-site" }, { "key": "user-agent", "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36" } ], "body": { "mode": "raw", "raw": "{\"url\":\"linkgraph.io\",\"refresh_interval\":7,\"country_code\":\"us\",\"language\":\"English\",\"precise_location\":\"United States\",\"description\":\"\",\"name\":\"Linkgraph\"}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://keyword.searchatlas.com/api/v1/rank-tracker/#{{project_id}}/?searchatlas_api_key=<your_api_key>", "protocol": "https", "host": [ "keyword", "searchatlas", "com" ], "path": [ "api", "v1", "rank-tracker", "#{{project_id}}", "" ], "query": [ { "key": "searchatlas_api_key", "value": "<your_api_key>" } ] } }, "response": [] }, { "name": "List Projects", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [], "url": { "raw": "https://keyword.searchatlas.com/api/v1/rank-tracker/?searchatlas_api_key=<your_api_key>", "protocol": "https", "host": [ "keyword", "searchatlas", "com" ], "path": [ "api", "v1", "rank-tracker", "" ], "query": [ { "key": "searchatlas_api_key", "value": "<your_api_key>" } ] } }, "response": [] }, { "name": "Add Tracked Keyword", "request": { "auth": { "type": "noauth" }, "method": "PUT", "header": [ { "key": "accept", "value": "application/json, text/plain, */*" }, { "key": "accept-language", "value": "en-US,en;q=0.9" }, { "key": "authorization", "value": "Bearer REDACTED-EXPIRED-EXAMPLE-TOKEN" }, { "key": "content-type", "value": "application/json" }, { "key": "origin", "value": "https://dashboard.linkgraph.com" }, { "key": "priority", "value": "u=1, i" }, { "key": "referer", "value": "https://dashboard.linkgraph.com/" }, { "key": "sec-ch-ua", "value": "\"Not/A)Brand\";v=\"8\", \"Chromium\";v=\"126\", \"Google Chrome\";v=\"126\"" }, { "key": "sec-ch-ua-mobile", "value": "?0" }, { "key": "sec-ch-ua-platform", "value": "\"macOS\"" }, { "key": "sec-fetch-dest", "value": "empty" }, { "key": "sec-fetch-mode", "value": "cors" }, { "key": "sec-fetch-site", "value": "cross-site" }, { "key": "user-agent", "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36" } ], "body": { "mode": "raw", "raw": "[\n {\n \"keyword\": \"linkgraph\",\n \"location\": \"United States\"\n },\n {\n \"keyword\": \"link building\",\n \"location\": \"United States\"\n },\\\n\n]", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://keyword.searchatlas.com/api/v2/rank-tracker/#{{project_id}}/tracked-keywords/?searchatlas_api_key=<your_api_key>", "protocol": "https", "host": [ "keyword", "searchatlas", "com" ], "path": [ "api", "v2", "rank-tracker", "#{{project_id}}", "tracked-keywords", "" ], "query": [ { "key": "searchatlas_api_key", "value": "<your_api_key>" } ] } }, "response": [] }, { "name": "Refresh Serps", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://keyword.searchatlas.com/api/v1/rank-tracker/#{{project_id}}/refresh/?searchatlas_api_key=<your_api_key>", "protocol": "https", "host": [ "keyword", "searchatlas", "com" ], "path": [ "api", "v1", "rank-tracker", "#{{project_id}}", "refresh", "" ], "query": [ { "key": "searchatlas_api_key", "value": "<your_api_key>" } ] } }, "response": [] }, { "name": "Keywords Details", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "accept", "value": "application/json, text/plain, */*" }, { "key": "accept-language", "value": "en-US,en;q=0.9" }, { "key": "authorization", "value": "Bearer REDACTED-EXPIRED-EXAMPLE-TOKEN" }, { "key": "origin", "value": "https://dashboard.linkgraph.com" }, { "key": "priority", "value": "u=1, i" }, { "key": "referer", "value": "https://dashboard.linkgraph.com/" }, { "key": "sec-ch-ua", "value": "\"Not/A)Brand\";v=\"8\", \"Chromium\";v=\"126\", \"Google Chrome\";v=\"126\"" }, { "key": "sec-ch-ua-mobile", "value": "?0" }, { "key": "sec-ch-ua-platform", "value": "\"macOS\"" }, { "key": "sec-fetch-dest", "value": "empty" }, { "key": "sec-fetch-mode", "value": "cors" }, { "key": "sec-fetch-site", "value": "cross-site" }, { "key": "user-agent", "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36" } ], "url": { "raw": "https://keyword.searchatlas.com/api/v1/rank-tracker/#{{project_id}}/keywords-details/?period2_start=2023-11-16&period2_end=2024-07-27&page=1&page_size=10&keyword_operator=contains&position=1&position_operator=greater_than&searchatlas_api_key=<your_api_key>&location=", "protocol": "https", "host": [ "keyword", "searchatlas", "com" ], "path": [ "api", "v1", "rank-tracker", "#{{project_id}}", "keywords-details", "" ], "query": [ { "key": "period2_start", "value": "2023-11-16" }, { "key": "period2_end", "value": "2024-07-27" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "10" }, { "key": "keyword_operator", "value": "contains", "description": "optional keyword filter operator" }, { "key": "position", "value": "1", "description": "optional position filter value" }, { "key": "position_operator", "value": "greater_than", "description": "optional position filter opertor neceessary when using position filter \nOther opearors (less_than, equal)" }, { "key": "searchatlas_api_key", "value": "<your_api_key>" }, { "key": "location", "value": "", "description": "optional use to filter the keyword location based on location i.e \"United States\"" } ] } }, "response": [] }, { "name": "Competitors List", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "accept", "value": "application/json, text/plain, */*" }, { "key": "accept-language", "value": "en-US,en;q=0.9" }, { "key": "authorization", "value": "Bearer REDACTED-EXPIRED-EXAMPLE-TOKEN" }, { "key": "origin", "value": "https://dashboard.linkgraph.com" }, { "key": "priority", "value": "u=1, i" }, { "key": "referer", "value": "https://dashboard.linkgraph.com/" }, { "key": "sec-ch-ua", "value": "\"Not/A)Brand\";v=\"8\", \"Chromium\";v=\"126\", \"Google Chrome\";v=\"126\"" }, { "key": "sec-ch-ua-mobile", "value": "?0" }, { "key": "sec-ch-ua-platform", "value": "\"macOS\"" }, { "key": "sec-fetch-dest", "value": "empty" }, { "key": "sec-fetch-mode", "value": "cors" }, { "key": "sec-fetch-site", "value": "cross-site" }, { "key": "user-agent", "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36" } ], "url": { "raw": "https://keyword.searchatlas.com/api/v1/rank-tracker/#{{project_id}}/competitors-by-visibility/?period2_start=2024-07-26&period2_end=2024-07-26&page=1&page_size=10&searchatlas_api_key=<your_api_key>", "protocol": "https", "host": [ "keyword", "searchatlas", "com" ], "path": [ "api", "v1", "rank-tracker", "#{{project_id}}", "competitors-by-visibility", "" ], "query": [ { "key": "period2_start", "value": "2024-07-26" }, { "key": "period2_end", "value": "2024-07-26" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "10" }, { "key": "searchatlas_api_key", "value": "<your_api_key>" } ] } }, "response": [] }, { "name": "Core Reports", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "accept", "value": "application/json, text/plain, */*" }, { "key": "accept-language", "value": "en-US,en;q=0.9" }, { "key": "authorization", "value": "Bearer REDACTED-EXPIRED-EXAMPLE-TOKEN" }, { "key": "origin", "value": "https://dashboard.linkgraph.com" }, { "key": "priority", "value": "u=1, i" }, { "key": "referer", "value": "https://dashboard.linkgraph.com/" }, { "key": "sec-ch-ua", "value": "\"Not/A)Brand\";v=\"8\", \"Chromium\";v=\"126\", \"Google Chrome\";v=\"126\"" }, { "key": "sec-ch-ua-mobile", "value": "?0" }, { "key": "sec-ch-ua-platform", "value": "\"macOS\"" }, { "key": "sec-fetch-dest", "value": "empty" }, { "key": "sec-fetch-mode", "value": "cors" }, { "key": "sec-fetch-site", "value": "cross-site" }, { "key": "user-agent", "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36" } ], "url": { "raw": "https://keyword.searchatlas.com/api/v1/rank-tracker/#{{project_id}}/core-reports/?period2_start=2024-07-26&period2_end=2024-07-26&searchatlas_api_key=<your_api_key>", "protocol": "https", "host": [ "keyword", "searchatlas", "com" ], "path": [ "api", "v1", "rank-tracker", "#{{project_id}}", "core-reports", "" ], "query": [ { "key": "period2_start", "value": "2024-07-26" }, { "key": "period2_end", "value": "2024-07-26" }, { "key": "searchatlas_api_key", "value": "<your_api_key>" } ] } }, "response": [] }, { "name": "Remove Tracked keywords", "request": { "auth": { "type": "noauth" }, "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"keyword\": \"test\",\n \"location\": \"\"\n },\n {\n \"keyword\": \"test2\",\n \"location\": \"Pakistan\"\n }\n]", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://keyword.searchatlas.com/api/v2/rank-tracker/#{{project_id}}/tracked-keywords/?searchatlas_api_key=<your_api_key>", "protocol": "https", "host": [ "keyword", "searchatlas", "com" ], "path": [ "api", "v2", "rank-tracker", "#{{project_id}}", "tracked-keywords", "" ], "query": [ { "key": "searchatlas_api_key", "value": "<your_api_key>" } ] } }, "response": [] }, { "name": "Remove Project", "request": { "auth": { "type": "noauth" }, "method": "DELETE", "header": [], "url": { "raw": "https://keyword.searchatlas.com/api/v1/rank-tracker/#{{project_id}}/?searchatlas_api_key=<your_api_key>", "protocol": "https", "host": [ "keyword", "searchatlas", "com" ], "path": [ "api", "v1", "rank-tracker", "#{{project_id}}", "" ], "query": [ { "key": "searchatlas_api_key", "value": "<your_api_key>" } ] } }, "response": [] }, { "name": "Keyword Histrorical Performance", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [], "url": { "raw": "https://keyword.searchatlas.com/api/v2/rank-tracker/#{{project_id}}/keyword-historical-performance/?keyword=searchatlas&location=United+States&searchatlas_api_key=<your_api_key>", "protocol": "https", "host": [ "keyword", "searchatlas", "com" ], "path": [ "api", "v2", "rank-tracker", "#{{project_id}}", "keyword-historical-performance", "" ], "query": [ { "key": "keyword", "value": "searchatlas" }, { "key": "location", "value": "United+States" }, { "key": "searchatlas_api_key", "value": "<your_api_key>" } ] } }, "response": [] } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }
```