API usage example

Login and get API token

Discover how to get your unique API key 

curl -X POST 'https://app.boostramp.com/api/login.php' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'key=%your-api-key%'


Get the account projects list


cURL

curl --location 'https://app.boostramp.com/api/project.php?token=Hvmx1o6NKPeNalPA43KXhCHwnPVWmcno&func=listProjects'


php CURL

<?php
$curl = curl_init();
curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://app.boostramp.com/api/project.php?token=Hvmx1o6NKPeNalPA43KXhCHwnPVWmcno&func=listProjects',
  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;


Python

import requests
url = "https://app.boostramp.com/api/project.php?token=Hvmx1o6NKPeNalPA43KXhCHwnPVWmcno&func=listProjects"
payload = {}
headers = {
  'Cookie': 'PHPSESSID=tmd4so8iqcueopnvuiipe0292d'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)


If everything is done correctly, you will receive a JSON response containing all your projects.

[
    {
        "id": 001,
        "name": "demo1.com",
        "domain": "demo1.com",
        "ownership": 0,
        "type": 1,
        "target": 1,
        "cms": 7,
        "keywords_region": 84,
        "keywords_region_name": "United States",
        "crawling_frequency": 7,
        "keywords_frequency": 1,
        "backlinks_scan_frequency": 3,
        "backlinks_monitoring_frequency": 3,
        "monitoring_frequency": 60,
        "date_added": "2023-08-21 06:54:44",
        "date_edit": "2023-08-22 19:04:53",
        "google_search_console": 1
    },
    {
        "id": 107,
        "name": "demo2.com",
        "domain": "demo2.com",
        "ownership": 0,
        "type": 1,
        "target": 1,
        "cms": 1,
        "keywords_region": 84,
        "keywords_region_name": "United States",
        "crawling_frequency": 7,
        "keywords_frequency": 1,
        "backlinks_scan_frequency": 3,
        "backlinks_monitoring_frequency": 3,
        "monitoring_frequency": 60,
        "date_added": "2023-08-21 08:57:51",
        "date_edit": "2023-08-22 19:05:07",
        "google_search_console": 1
    },
    {
        "id": 128,
        "name": "demo3.com",
        "domain": "demo3.com",
        "ownership": 0,
        "type": 1,
        "target": 1,
        "cms": 1,
        "keywords_region": 84,
        "keywords_region_name": "United States",
        "crawling_frequency": 7,
        "keywords_frequency": 1,
        "backlinks_scan_frequency": 3,
        "backlinks_monitoring_frequency": 3,
        "monitoring_frequency": 10,
        "date_added": "2023-08-21 08:58:39",
        "date_edit": "2023-09-25 10:58:29",
        "google_search_console": 1
    },
    {
        "id": 642,
        "name": "demo4.com,
        "domain": "demo4.com",
        "ownership": 0,
        "type": 1,
        "target": 1,
        "cms": 1,
        "keywords_region": 130,
        "keywords_region_name": "London",
        "crawling_frequency": 2,
        "keywords_frequency": 1,
        "backlinks_scan_frequency": 2,
        "backlinks_monitoring_frequency": 1,
        "monitoring_frequency": 60,
        "date_added": "2023-10-13 06:43:18",
        "date_edit": "2023-10-13 06:43:18",
        "google_search_console": 0
    }
]