Google indexing API reference

Quick start

1. Get a key. Open @IndexForgeBot and press 🔑 API. The key is shown once, so save it.
2. Send URLs. POST /v1/submit with a JSON array of up to 10,000 URLs. You get a task id right away.
3. Poll the task. GET /v1/tasks/{id} every 10 seconds or so, until the status is done, partial or failed.
4. Read the result. Accepted, rejected with reasons, charged and refunded, all in one object.

$ curl -X POST https://api.indexforge.help/v1/submit \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"urls": [
        "https://site.com/page-1",
        "https://site.com/page-2"]}'

import requests, time

API = "https://api.indexforge.help"
H = {"Authorization": "Bearer YOUR_KEY"}

task = requests.post(API + "/v1/submit", headers=H, json={"urls": urls}).json()["task"]
while task["status"] in ("queued", "checking", "submitting"):
    time.sleep(10)
    task = requests.get(API + "/v1/tasks/" + task["id"], headers=H).json()["task"]
print(task["accepted"], "accepted", task.get("rejected", 0), "rejected")

const API = "https://api.indexforge.help";
const H = { Authorization: "Bearer YOUR_KEY", "Content-Type": "application/json" };

let { task } = await (await fetch(API + "/v1/submit", {
  method: "POST", headers: H, body: JSON.stringify({ urls })
})).json();
while (["queued", "checking", "submitting"].includes(task.status)) {
  await new Promise(r => setTimeout(r, 10000));
  ({ task } = await (await fetch(API + "/v1/tasks/" + task.id, { headers: H })).json());
}
console.log(task.accepted, "accepted");

$ch = curl_init("https://api.indexforge.help/v1/submit");
curl_setopt_array($ch, [
  CURLOPT_POST => true,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ["Authorization: Bearer YOUR_KEY", "Content-Type: application/json"],
  CURLOPT_POSTFIELDS => json_encode(["urls" => $urls]),
]);
$task = json_decode(curl_exec($ch), true)["task"];

202 Accepted · 184 ms # 202 · task created
{ "ok": true,
  "task": { "id": "3f9c2a7d1b6e4c80",
            "status": "queued", "urls": 2 } }

Base URL and authentication

All requests go to https://api.indexforge.help. Bodies and responses are JSON in UTF-8, and every response has an ok field.

Pass your key in either header:

Authorization: Bearer YOUR_KEY
X-API-Key: YOUR_KEY

• The key is issued in the bot with the 🔑 API button and shown once. Store it like a password.
• Generating a new key immediately disables the old one. Do that if a key leaks.
• The API and the bot share one balance: top up in the bot, spend from either.

POST /v1/submit

Creates a task: checks the URLs the way Googlebot sees them, then sends the ones that pass for indexing.

{ "urls": ["https://site.com/page-1", "https://site.com/page-2"], "check": true }

Response 202 Accepted with the new task:

{ "ok": true,
  "task": { "id": "3f9c2a7d1b6e4c80", "status": "queued",
            "created": 1760263200, "urls": 2 } }

GET /v1/tasks/{id}

Status and counters for one task. Tasks are visible only to the key's owner.

{ "ok": true, "task": {
  "id": "3f9c2a7d1b6e4c80", "status": "done",
  "created": 1760263200, "finished": 1760263295,
  "urls": 3, "checked": 3, "rejected": 1,
  "rejected_urls": { "404": ["https://site.com/old"] },
  "accepted": 2, "charged": 2, "refunded": 0 } }

Reasons in rejected_urls:

GET /v1/tasks

Your recent tasks, newest first. Optional limit from 1 to 100, default 20.

GET /v1/tasks?limit=20

{ "ok": true, "tasks": [ { "id": "3f9c2a7d1b6e4c80", "status": "done", … }, … ] }

GET /v1/balance

Credits left on the account and the current price.

{ "ok": true, "balance": 1250, "unlimited": false, "price_per_url_usd": 0.01 }

Task statuses

A finished task ends in one of three states:

• done: everything that passed the check was accepted. If nothing passed, the task is also done with accepted: 0 and nothing charged.
• partial: some URLs were accepted, credits for the rest were refunded.
• failed: nothing was sent and reserved credits were refunded.

The error field explains a partial or failed result:

Errors

Errors come back with an HTTP status and a JSON body, so your code can tell a bad request from an empty balance:

{ "ok": false, "error": "insufficient_credits", "message": "Balance is 0. Top up in the bot." }

Limits

Indexing usually takes 1–3 days after a task finishes. Price: $0.01 per accepted URL, the same as in the bot.

API questions