API V1
The IndexChecker API lets you check index status for one or more URLs using your API token. Credits are charged only for definitive results (Page Index / Page Not Index).
Authentication
This API uses an access token. Generate or rotate your token in the API page.
X-Access-Token: {YOUR_TOKEN}Check Index Status
Check index status for one or more URLs. Credits are charged only for definitive results.
Endpoint
POST /api/v1/checkHeaders
| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Access-Token | string | required | Your API token |
| Content-Type | string | required | application/json |
Body
| Parameter | Type | Required | Description |
|---|---|---|---|
| urls | array | required | Array of URLs to check. Processed at 1 URL/second on the server. |
cURL Example
curl -X POST \
https://app.indexchecker.io/api/v1/check \
-H "Content-Type: application/json" \
-H "X-Access-Token: YOUR_TOKEN" \
-d '{
"urls": [
"https://example.com/page1",
"https://example.com/page2"
]
}'Example Request
{
"urls": [
"https://example.com/page1",
"https://example.com/page2"
]
}Example Response
{
"ok": true,
"charged": 2,
"results": [
{ "url": "https://example.com/page1", "status": "Page Index" },
{ "url": "https://example.com/page2", "status": "Page Not Index" }
]
}Check Credits
Check your remaining credits balance. This endpoint uses GET method and requires only the authentication header.
Endpoint
GET /api/v1/creditsHeaders
| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Access-Token | string | required | Your API token |
Body
No request body required for GET requests.
cURL Example
curl -X GET \
https://app.indexchecker.io/api/v1/credits \
-H "X-Access-Token: YOUR_TOKEN"Example Response
{
"ok": true,
"credits_remaining": 200,
"user_name": "John Doe"
}Error Handling
The API uses standard HTTP status codes to indicate the success or failure of an API request. In general, 2xx status codes indicate success, 4xx status codes indicate an error that failed given the information provided (e.g., a required parameter was missing, a charge failed, etc.), and 5xx status codes indicate an error with IndexChecker's servers.
Error Response
{
"status": "error",
"message": "Invalid API key provided."
}Status Codes
Example Error Responses
{
"error": "Invalid or revoked token"
}{
"error": "Insufficient credits"
}{
"message": "Too Many Attempts."
}
