REST API reference

• Base URL: https://indexerpal.com/api/v1. Machine-readable: OpenAPI 3.1.
• Authentication: Authorization: Bearer ipk_... (an API key) or an OAuth access token. See authentication.
• JSON in and out, snake_case fields, timestamps in ISO 8601 UTC, money in cents. Unknown fields may appear: ignore them.
• Lists take limit and offset, or page and per_page.
• CORS is open: browsers can call the API with a bearer token.
• GET /api/v1 with Accept: application/json lists every endpoint. Without that header, and where x402 is on, the same URL returns 402 and the price of the basic pack. GET /api/v1/health reports status.

The account behind the credential.

Get account

GET /api/v1/account

The account behind this credential: credit balance, whether it can index yet (it needs one paid order), this credential's scopes, today's usage and the limits.

Any credential · MCP tool get_account.

Parameters

No parameters.

Example

curl "https://indexerpal.com/api/v1/account" \
  -H "Authorization: Bearer ipk_YOUR_KEY"

Response (200)

Public: no credential needed (with one, the estimate also checks your balance).

Get pricing

GET /api/v1/pricing

Credit packs and prices (one-time payments in US dollars, credits never expire), what each action costs in credits, and when URLs are checked in Google.

No credential needed · MCP tool get_pricing.

Parameters

No parameters.

Example

curl "https://indexerpal.com/api/v1/pricing"

Response (200)

Estimate cost

POST /api/v1/estimate

How many credits a submission would cost, before spending anything. Send the URLs to also learn how many are valid, duplicated or not indexable. With a credential, says whether the balance covers it.

No credential needed · MCP tool estimate_cost.

Parameters

Example

curl -X POST "https://indexerpal.com/api/v1/estimate" \
  -H "Content-Type: application/json" \
  -d '{"kind":"instant","urls":["https://example.com/new-post","https://example.com/launch"]}'

Response (200)

An indexing project sends its URLs through IndexerPal's indexing system and checks each one in Google; a check (kind check) only looks URLs up in Google. Both are projects: list and read them the same way.

Index URLs

POST /api/v1/projects

Creates an indexing project: IndexerPal's own indexing system gets the pages or backlinks indexed in Google (and Bing and Yandex unless turned off), then verifies each URL in Google (instant: within the hour; all: day 4 and day 14). Spends credits at once (1 per URL standard, 3 instant). Returns the project; follow it with get_project.

Scope index · needs a paid account · accepts Idempotency-Key · MCP tool submit_urls.

Parameters

Example

curl -X POST "https://indexerpal.com/api/v1/projects" \
  -H "Authorization: Bearer ipk_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"urls":["https://example.com/new-post","https://guest-blog.example.org/my-article"],"mode":"standard","name":"October posts"}'

Response (201)

Index a sitemap

POST /api/v1/projects/from-sitemap

Reads an XML sitemap (or sitemap index, one level deep; .xml.gz works) and creates an indexing project with its page URLs in one step. Set skip_already_submitted to send only URLs this account never submitted before, which suits recurring runs.

Scope index · needs a paid account · accepts Idempotency-Key · MCP tool submit_sitemap.

Parameters

Example

curl -X POST "https://indexerpal.com/api/v1/projects/from-sitemap" \
  -H "Authorization: Bearer ipk_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"sitemap_url":"https://example.com/sitemap.xml","skip_already_submitted":true,"mode":"standard"}'

Response (201)

Add URLs to a project

POST /api/v1/projects/{project_id}/urls

Adds URLs to an existing indexing project. They are sent with the project's settings (mode, search engines, drip feed from now) and spend credits at once. URLs already in the project are skipped and cost nothing. A finished project becomes active again. Up to 10,000 URLs per call, 50,000 per project.

Scope index · needs a paid account · accepts Idempotency-Key · MCP tool add_urls.

Parameters

Example

curl -X POST "https://indexerpal.com/api/v1/projects/PROJECT_ID/urls" \
  -H "Authorization: Bearer ipk_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"urls":["https://example.com/another-post"]}'

Response (201)

Check if URLs are indexed

POST /api/v1/checks

The index checker: looks each URL up in Google without sending anything. 10 URLs per credit (rounded up). Results usually arrive within the hour; read them with get_project and list_links.

Scope index · needs a paid account · accepts Idempotency-Key · MCP tool check_urls.

Parameters

Example

curl -X POST "https://indexerpal.com/api/v1/checks" \
  -H "Authorization: Bearer ipk_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"urls":["https://example.com/a","https://example.com/b"]}'

Response (201)

List projects

GET /api/v1/projects

Indexing projects and index checks on this account, newest first, with their counts and index rate.

Scope read · MCP tool list_projects.

Parameters

Example

curl "https://indexerpal.com/api/v1/projects?kind=index&limit=20" \
  -H "Authorization: Bearer ipk_YOUR_KEY"

Response (200)

Get project

GET /api/v1/projects/{project_id}

One project or check: live counts per status, index rate, credits spent and returned.

Scope read · MCP tool get_project.

Parameters

Example

curl "https://indexerpal.com/api/v1/projects/PROJECT_ID" \
  -H "Authorization: Bearer ipk_YOUR_KEY"

Response (200)

List a project's URLs

GET /api/v1/projects/{project_id}/links

The URLs of a project with their status (scheduled, queued, pushed, sent, indexed, not_indexed, failed), dates and next check. Filter by group and search by text; paginated.

Scope read · MCP tool list_links.

Parameters

Example

curl "https://indexerpal.com/api/v1/projects/PROJECT_ID/links?status=not_indexed&per_page=100" \
  -H "Authorization: Bearer ipk_YOUR_KEY"

Response (200)

Cancel unsent URLs

POST /api/v1/projects/{project_id}/cancel

Takes the URLs of a project that haven't been sent yet (drip feed or queue) out, and returns their credits. URLs already sent are not affected.

Scope index · MCP tool cancel_pending_links.

Parameters

Example

curl -X POST "https://indexerpal.com/api/v1/projects/PROJECT_ID/cancel" \
  -H "Authorization: Bearer ipk_YOUR_KEY"

Response (200)

Rename project

PATCH /api/v1/projects/{project_id}

Changes a project's or check's name.

Scope index · MCP tool rename_project.

Parameters

Example

curl -X PATCH "https://indexerpal.com/api/v1/projects/PROJECT_ID" \
  -H "Authorization: Bearer ipk_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Launch week"}'

Response (200)

Read a sitemap without submitting it. To index one, use submit_sitemap above.

Read a sitemap

POST /api/v1/sitemaps/read

Lists the page URLs in an XML sitemap (or sitemap index) without submitting anything. To index a whole sitemap in one step, use submit_sitemap.

Scope index · MCP tool read_sitemap.

Parameters

Example

curl -X POST "https://indexerpal.com/api/v1/sitemaps/read" \
  -H "Authorization: Bearer ipk_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/sitemap.xml","limit":100}'

Response (200)

A checkout link is paid by a person on Stripe; the order turns paid the moment they pay.

Buy credits

POST /api/v1/checkout

Creates a secure Stripe checkout link for a credit pack. Give checkout_url to the account owner to pay by card; credits arrive the moment they pay. Poll get_order to know when. Prices are final: nothing is added at checkout.

Scope purchase · accepts Idempotency-Key · MCP tool buy_credits.

Parameters

Example

curl -X POST "https://indexerpal.com/api/v1/checkout" \
  -H "Authorization: Bearer ipk_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"pack":"premium"}'

Response (201)

Get order

GET /api/v1/orders/{order_id}

A credit purchase: pending until the person pays, then paid (credits added). Use it to wait for a checkout link to be paid.

Scope read · MCP tool get_order.

Parameters

Example

curl "https://indexerpal.com/api/v1/orders/ORDER_ID" \
  -H "Authorization: Bearer ipk_YOUR_KEY"

Response (200)

List orders

GET /api/v1/orders

Credit purchases on this account, newest first (paid, refunded, and checkouts still open).

Scope read · MCP tool list_orders.

Parameters

Example

curl "https://indexerpal.com/api/v1/orders?limit=10" \
  -H "Authorization: Bearer ipk_YOUR_KEY"

Response (200)

Credit history

GET /api/v1/credits/history

Every change to the balance, newest first: purchases, credits spent on projects, credits back for URLs not indexed, refunds.

Scope read · MCP tool get_credit_history.

Parameters

Example

curl "https://indexerpal.com/api/v1/credits/history?limit=20" \
  -H "Authorization: Bearer ipk_YOUR_KEY"

Response (200)

Where this deployment accepts x402, an agent can pay for a pack in USDC with no person involved. The endpoint answers 404 not_enabled where it doesn't.

POST /api/v1/credits/x402 · Scope purchase.

1. Call it with {"pack": "pro"}. The answer is 402 even with no credential, so the price can be read first: a PAYMENT-REQUIRED header (x402 v2, base64 JSON) and a WWW-Authenticate: Payment challenge (MPP, method evm). Both name the network, the USDC contract, the amount and the address to pay. GET on the same URL returns the same 402. A call with no pack prices the basic pack.
2. Sign the payment with your x402 client and send the same request again with the PAYMENT-SIGNATURE header and Authorization: Bearer (an API key or an access token). A signature sent without the credential is not submitted. The official x402 client refuses any single payment over $1 by default: raise spendControls.maxAmountPerPayment to at least the pack's price.
3. The payment is verified and settled; the answer is 200 with the order, the new balance, the transaction and a PAYMENT-RESPONSE header.
4. Each signed payment counts once: sending the same PAYMENT-SIGNATURE again returns the first purchase (Idempotent-Replayed: true). If the answer is 409 payment_pending, the transfer is on its way: retry the same request with the same signature after Retry-After, and don't sign a new payment.

curl -i -X POST https://indexerpal.com/api/v1/credits/x402 \
  -H "Authorization: Bearer ipk_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"pack": "pro"}'

Errors are {"error": {"code", "message", ...}} with the HTTP status below. Branch on code; show message to people.