AlterLabAPI Reference
Auto-generated
Serp
API reference for serp endpoints.
Auto-generated
This page was generated from the OpenAPI spec. Run
make generate-docs to refresh after spec changes.GET /api/v1/serp/history
GET
/api/v1/serp/historyGet SERP result history for keyword tracking
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| query | string | Required | query |
| search_engine | string | Optional | search_engineDefault: google |
| country | string | Optional | country |
| language | string | Optional | language |
| from_date | string | Optional | from_date |
| to_date | string | Optional | to_date |
| limit | integer | Optional | limitDefault: 50 |
| offset | integer | Optional | offsetDefault: 0 |
| include_changes | boolean | Optional | include_changesDefault: True |
Request Example
Bash
curl -X GET 'https://api.alterlab.io/api/v1/serp/history?query=<query>' \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json"Response Example
JSON
{
"query": "example",
"search_engine": "example",
"country": "example",
"total_snapshots": 0,
"snapshots": [],
"changes": "example"
}POST /api/v1/serp/keyword-ideas
POST
/api/v1/serp/keyword-ideasKeyword ideas from autocomplete, People Also Ask and related searches
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| seed | string | Required | Seed keyword or phrase |
| country | string | Optional | ISO country codeDefault: us |
| language | string | Optional | Language codeDefault: en |
| depth | integer | Optional | 1: seed + a-z + question prefixes; 2 also expands the best ideas (up to 60 calls)Default: 1 |
| sources | string[] | Optional | Sources to fan out to |
| quote_only | boolean | Optional | Return the quote without running or billing anythingDefault: False |
Request Example
Bash
curl -X POST https://api.alterlab.io/api/v1/serp/keyword-ideas \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"seed": "example_seed",
"country": "example_country",
"language": "example_language",
"depth": 1
}'Response Example
JSON
{
"seed": "example",
"country": "example",
"language": "example",
"depth": 0,
"sources": [],
"quote": "example"
}POST /api/v1/serp/sessions
POST
/api/v1/serp/sessionsRegister a persistent SERP session
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| geo | string | Optional | geo |
Request Example
Bash
curl -X POST https://api.alterlab.io/api/v1/serp/sessions \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json"Response Example
JSON
{
"status": "ok"
}GET /api/v1/serp/sessions
GET
/api/v1/serp/sessionsList persistent SERP sessions
Request Example
Bash
curl -X GET https://api.alterlab.io/api/v1/serp/sessions \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json"Response Example
JSON
{
"sessions": [],
"total": 0
}GET /api/v1/serp/sessions/{session_id}
GET
/api/v1/serp/sessions/{session_id}Inspect a persistent SERP session
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| session_id | string | Required | Session ID |
Request Example
Bash
curl -X GET https://api.alterlab.io/api/v1/serp/sessions/<session_id> \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json"Response Example
JSON
{
"session_id": "example",
"state": "example",
"geo": "example",
"search_count": 0,
"block_count": 0,
"success_count": 0
}DELETE /api/v1/serp/sessions/{session_id}
DELETE
/api/v1/serp/sessions/{session_id}Retire a persistent SERP session
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| session_id | string | Required | Session ID to retire |
Request Example
Bash
curl -X DELETE https://api.alterlab.io/api/v1/serp/sessions/<session_id> \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json"Response Example
JSON
{
"status": "ok"
}