Developer Resources

REST API Reference

Integrate bulk index checking directly into your own dashboards, tools, or scripts. Automate your SEO workflow with our high-throughput API.

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).

POST

Create Project

Create a new checking project with a list of URLs.

https://app.indexchecker.link/api/project/create
apikey required string

Your secret API key.

project_name required string

Name of your project.

urls required string

List of URLs separated by a pipe symbol |.

description optional string
cURL Example POST
curl -X POST https://app.indexchecker.link/api/project/create \
  -d “apikey=YOUR_API_KEY” \
  -d “project_name=MyProject” \
  -d “urls=https://site1.com|https://site2.com”
Response 200 OK
{
  “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
}
POST

Get Project Details

Retrieve the status, statistics and links of a specific project.

https://app.indexchecker.link/api/project/show
apikey required
project_id required int

ID of the project you want to fetch.

Response 200 OK
{
  “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
  }
}
* Status codes: 1 (Indexed), 0 (Not Indexed), -1 (Check pending)
POST

List All Projects

Get a list of all your projects.

https://app.indexchecker.link/api/project/show_all
apikey required
Response
{
  “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”
  }
}
POST

Delete Project

Permanently remove a project and all associated data.

https://app.indexchecker.link/api/project/delete
apikey required
project_id required

ID of the project to delete.

Response
{
  “id”: “154”,
  “error”: 0,
  “message”: “The MyProject project has been deleted”
}
POST

Check Balance

Get your current credit limit.

https://app.indexchecker.link/api/check-balance
apikey required
Response 200 OK
{
  “limit”: 4500,
  “error”: 0
}