REST API Reference
Integrate bulk index checking directly into your own dashboards, tools, or scripts. Automate your SEO workflow with our high-throughput API.
The IndexChecker REST API lets you create checking projects, read their index status and check your credit balance from your own scripts and dashboards. Every request is authenticated with your secret API key in the POST body, endpoints return JSON, a project accepts up to 50,000 URLs, and 1 credit checks 1 URL.
What endpoints does the IndexChecker API have?
| Endpoint | Method | Purpose |
|---|---|---|
| /api/project/create | POST | Create a checking project from a list of URLs |
| /api/project/show | POST | Get a project's status, statistics and links |
| /api/project/show_all | POST | List all your projects |
| /api/project/delete | POST | Permanently delete a project |
| /api/check-balance | POST | Read your current credit balance |
Getting Started
Account
Authentication
Authenticate your requests by including your secret API Key in the request body (POST parameters).
You can find and manage your API Key in the Dashboard Settings.
Security Warning: Keep your API Key secure. Do not share it in publicly accessible code (e.g. client-side JS).
Create Project
Create a new checking project with a list of URLs.
Your secret API key.
Name of your project.
List of URLs separated by a pipe symbol |.
-d "apikey=YOUR_API_KEY" \
-d "project_name=MyProject" \
-d "urls=https://site1.com|https://site2.com"
"error": 0,
"message": "project MyProject has been added in it 2 links.",
"project_name": "MyProject",
"procjet_id": 154,
"project_id": 154,
"add_links_count": 2
}
Get Project Details
Retrieve the status, statistics and links of a specific project.
ID of the project you want to fetch.
"project_name": "MyProject",
"description": "optional description",
"date_created": "2023-10-12 14:30:00",
"project_id": "154",
"urls": {
"https://site1.com": "1",
"https://site2.com": "-1"
},
"statistics": {
"total_links": 2,
"indexed": 1,
"not_indexed": 0,
"pending": 1,
"percentage": 50
}
}
List All Projects
Get a list of all your projects.
"154": {
"project_name": "MyProject",
"description": "",
"date_created": "2023-10-12 14:30:00"
},
"155": {
"project_name": "Another Project",
"description": "SEO Audit",
"date_created": "2023-10-13 09:15:00"
}
}
Delete Project
Permanently remove a project and all associated data.
ID of the project to delete.
"id": "154",
"error": 0,
"message": "The MyProject project has been deleted"
}
Check Balance
Get your current credit limit.
"limit": 4500,
"error": 0
}
Frequently Asked Questions
How do I authenticate API requests?
Include your secret API key as the apikey parameter in the POST body of every request. You find and manage the key in your dashboard settings.
How many URLs can one API project hold?
Up to 50,000 URLs per project, the same limit as the dashboard. Separate them with a pipe symbol in the urls parameter when you create a project.
What does an API check cost?
1 credit per URL checked, including the second-datacenter re-check. Credits never expire and API access is included on every plan, from the free trial up.
What format does the API return?
JSON. Each endpoint returns an error field, which is 0 on success, plus the project data - status, statistics and per-URL index results where applicable.
IndexChecker is a bulk Google index checker operated by AP2Media Sp. z o.o., a registered EU company based in Czerwin, Poland (VAT ID PL7582396091). It is used in production on the company's own SEO projects, including the local-SEO service drukujemy3d.pl, and has verified more than two million URLs for its customers in the last 30 days.
The official Google documentation behind how indexing works and how to check it.