API Documentation

Getting started 🔗

Links Indexer exposes a simple REST API that speaks JSON, so you can create campaigns straight from your own system. Setup takes two steps: copy your api_token from the Settings page, then point your requests at the endpoints below.

Want to test your integration before committing? Create a free account and then contact us; we'll switch your account to a developer one so you can experiment freely.

Every endpoint below lives under this base URL, and each one accepts GET as well as POST requests.

New to Links Indexer? Read about our link indexing service, compare plans and pricing, or browse the frequently asked questions.

Get your API key →

Overview 🔗

The Links Indexer API gives you direct access to our web services. You send an HTTP request, the API processes it, and you get JSON back.

Day to day, that means creating new campaigns, setting dripfeed days, checking how many daily credits you have left, and indexing links through your XML RPC requests.

Authentication 🔗

Every request must carry your api_token, which you'll find on the Links Indexer Settings page. Pass it as a request body parameter or as a URL query parameter; both work the same way.

Variables & Codes 🔗

When a request fails, the Links Indexer API returns three things: a success flag, a message, and an errors object that lists each field that needs fixing.

{
    "success": false,
    "message": "Input Fields Validation Error",
    "errors": {
        "api_token": [
            "API Token is required"
        ],
        "urls": [
            "URLS are required"
        ]
    }
}

[GET] Health 🔗

Returns the current server time. Useful as a quick smoke test: hit it once to confirm the API is up and responding before you send real requests.

<?php

$api_token = 'YOUR_API_KEY_HERE';

// build the POST/GET query string
$qstring = 'api_token=' . $api_token;

// Do the API Request using CURL functions
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL            => 'https://linksindexer.com/api/health-check',
    CURLOPT_POSTFIELDS     => $qstring,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING       => '',
    CURLOPT_MAXREDIRS      => 10,
    CURLOPT_TIMEOUT        => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION   => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST  => 'GET',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response:

{
    "success": true,
    "timestamp": "Mon, Dec 11, 2023 10:41 AM"  // current time in IST
}

[GET] Links Limit 🔗

Returns how many links you have left for today, so you can tell whether the next batch will fit. Calling it is optional: once your credits run out, the system rejects further requests on its own.

<?php

$api_token = 'YOUR_API_KEY_HERE';

// build the POST/GET query string
$qstring = 'api_token=' . $api_token;

// Do the API Request using CURL functions
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL            => 'https://linksindexer.com/api/credits',
    CURLOPT_POSTFIELDS     => $qstring,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING       => '',
    CURLOPT_MAXREDIRS      => 10,
    CURLOPT_TIMEOUT        => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION   => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST  => 'GET',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response:

{
    "success": true,
    "message": 50000
}

Parameters

[POST] Create Campaign 🔗

New API campaigns get a default 7 days dripfeed: links submitted today start getting pinged tomorrow. Want them indexed right away? Send dripfeed=0 instead.

<?php

$api_token = 'YOUR_API_KEY_HERE';
$campaign_name = 'CAMPAIGN_NAME_HERE'; // OPTIONAL

// All URLS to be sent are hold in an array for example
$urls = array('http://www.example.com', 'http://www.example.com/title');

// build the POST query string and join the URLs array with | (single pipe)
$qstring = 'api_token=' . $api_token . '&campaign_name=' . $campaign_name
    . '&urls=' . urlencode(implode('|', $urls));

// Do the API Request using CURL functions
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL            => 'https://linksindexer.com/api/campaign/create',
    CURLOPT_POSTFIELDS     => $qstring,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING       => '',
    CURLOPT_MAXREDIRS      => 10,
    CURLOPT_TIMEOUT        => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION   => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST  => 'POST',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response:

{
    "success": true,
    "message": "API Campaign 2022-06-18 00:35:01 is successfully created!"
}

Parameters

Frequently asked questions 🔗

How do I authenticate with the Links Indexer API?

Every request must carry your api_token, which you'll find on the Links Indexer Settings page. Pass it as a request body parameter or as a URL query parameter; both work the same way.

How do I check my remaining link credits?

Call the /api/credits endpoint with your api_token. It returns how many links you have left for today. Calling it is optional: once your credits run out, the system rejects further requests on its own.

How do I create an indexing campaign?

Send your api_token, an optional campaign_name, and your pipe-separated urls to /api/campaign/create. New campaigns get a default 7 days dripfeed; send dripfeed=0 to have links indexed right away. See the Create Campaign section for a full example.

What happens if I submit more links than my daily limit?

The system accepts only as many links as your remaining daily limit allows, so a large batch never overdraws your credits.

For questions about the service itself - plans, credits, refunds - see the Links Indexer FAQ or compare our pricing plans.

Looking for answers about plans, credits, and indexing in general? Read the main Links Indexer FAQ.