top of page

API Documentation

We have an easy to use API so you can connect automatically to submit urls to our "get Indexed" and "check indexed" services and also to check your credit balance.  To view your API key visit your my account page here and click on the button there to show your API key.   

​

Note the API is only for submitting urls to one of our services i.e. to get them indexed or to check whether they are indexed) and not for querying the results of either service.  Results are currently delivered on a web page in a table with a .csv file download link but may in future be available via an API.

 

For any questions please email support@ultimateindexing.com 

​

Updated 29 June 2024 - identify main ("money") site urls.  It is best to submit main money website urls separately from third party backlink urls in a different batch.

<?php

//SIMPLY COMPLETE THE FIELDS IN RED BELOW IN THE CODE email,auth,service,drip & urls.

// for "get indexed" service complete all these fields.
// for "check indexed" service set set drip : 0
// For "check credit balance" service set drip : 0 and urls : ""

// RESPONSE FORMAT:

// For "get indexed" service the number of urls submitted is returned e.g. 1979 urls submitted
//{"service":"get indexed","submitted":1979}

// For "check indexed" service the number of urls submitted is returned e.g. 1252 urls submitted
//"service":"check indexed","submitted":1252}

// For "get credit balance" service the number of unused credits is returned e.g. 2162 credits remaining
// {"credits":2162}

// not authorised
//{"error":"Not authorized"}

//not enough credits
//{"error":"Not enough credits"}

//service error
//{"error":"invalid service"}

//invalid drip days
//{"error":"invalid drip"}

//error
{"error":"error"}

// ----------------------------------------------------------------------------------------------------------------

$url = "https://www.ultimateindexing.com/_functions/api/";
​
$agent = 'Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1)';

$curl = curl_init($url);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_USERAGENT, $agent);

$headers = [
    'Content-type: application/xml',
    'email: YOUR EMAIL ADDRESS HERE E.G. john_doe@gmail.com',
    'auth: YOUR API KEY HERE E.G. A1Y5ER1272U2EOK FIND THIS IN https://www.ultimateindexing.com/account/my-account',
];

$data = <<<DATA
{    
  "service": THE SERVICE YOUR REQUIRE HERE E.G. "get indexed" OR "check indexed" OR "get credit balance",
  "confirmation_email" : WHETHER YOU WANT A CONFIRMATION EMAIL AFTER USING THE API i.e. "yes" or "no",
  "drip" : THE NUMBER OF DRIP DAYS FOR SUBMITTING URLS OVER from 1 to 30 E.G. 5,
  "money_site" : WHETHER THE URLS CONTAIN YOUR MAIN ("money") WEBSITE i.e. true or false,
   "urls": YOUR LIST OF URLS TO SUBMIT HERE SEPARATED BY COMMAS e.g "https://example.com/page-1.html,https://example.com/page-2.html"
}
DATA;

curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);

$resp = curl_exec($curl);
echo $resp;
curl_close($curl);
?>

AN ACTUAL EXAMPLE BELOW TO GET 2 URLS INDEXED:

<?php

$url = "https://www.ultimateindexing.com/_functions/api/";
 
$agent = 'Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1)';

$curl = curl_init($url);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_USERAGENT, $agent);

$headers = [
    'Content-type: application/xml',
   'email: john.doe@gmail.com',
    'auth: Djyg+O7K0wnrKx1BtJrXDEk6@@xh$121',
];

$data = <<<DATA
{    
  "service": "get indexed",
  "confirmation_email": "no",
  "drip" : 1,
  "money_site" : false,
  "urls":"https://bbc.co.uk,https://cnn.com"
}
DATA;

curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);

$resp = curl_exec($curl);
echo $resp;
curl_close($curl);
?>

 
bottom of page