PromoPilot API

A single REST API for the whole PromoPilot ecosystem: launch link promotion, track rankings, run SEO audits and security scans from your own code — CRM, SaaS or an agency panel.

• Base URL: https://promopilot.link/api/v1
• The format is JSON over HTTPS; every response contains an ok field.
• Projects created via the API appear in the dashboard in a separate “API projects” section and carry a badge — they are not mixed with personal ones.
• Machine-readable specification: openapi.json

curl https://promopilot.link/api/v1/ping
# {"ok":true,"pong":true,"time":"2026-07-20T12:00:00Z"}

Authorisation and keys

API keys are issued in the client dashboard: Dashboard → API for developers. When creating a key you choose which services it may access (scopes): promotion, rank, audit, shield. The key is shown in full only once — we store nothing but its SHA-256 fingerprint.

Authorization: Bearer ppk_your_key# или
X-Api-Key: ppk_your_key

Billing and balance

• All paid operations are charged to the account’s personal balance — the same one as in the dashboard. There is no separate “API balance”.
• Promotion: the price comes from the plan, the flexible cascade or the global price, minus your personal discount; Pro subscribers automatically get an extra 10% off.
• You can get the exact price before launching: POST /promotion/quote (no charge).
• Rank Tracker is charged for the checks actually performed; SEO Audit full is prepaid based on the size estimate; Shield deep/comprehensive has a fixed scan price.
• If there are not enough funds you get HTTP 402 insufficient_funds with the fields required, balance, shortfall and a topup_url link. Topping up is done in the dashboard.

Error format

{
  "ok": false,
  "error": {
    "code": "insufficient_funds",
    "message": "Not enough funds on your balance. Top it up in the dashboard and repeat the request.",
    "details": {"required": 44.1, "balance": 10.0, "shortfall": 34.1, "topup_url": "…"}
  }
}

Limits

• 120 requests per minute per key (the base limit).
• Promotion launches — up to 20 a minute; project creation — up to 30 an hour; audit and scan launches — up to 10 a minute.
• On exceeding the limit you get HTTP 429 with a Retry-After header. The recommended status polling interval is once every 30–60 seconds.

Localization

Human-readable messages (message) come back in the language from the ?lang= parameter (ru, en, uk, pl) or the Accept-Language header; by default, your account language. Machine error codes and statuses are never translated — bind your logic to those.

Endpoint reference

Account

{"ok":true,"user":{"id":2,"balance":124.50,"currency":"USD","promotion_discount_percent":10,"is_pro":true,...},"key":{"label":"CRM","scopes":["promotion"]}}

{"ok":true,"balance":124.50,"currency":"USD","topup_url":"…/client/balance.php"}

{"ok":true,"key":{"label":"CRM","scopes":["promotion","rank"],"requests_total":1520,...}}

Projects and links scope: promotion

{"ok":true,"projects":[{"id":311,"name":"Client A","created_via":"api","links_count":3,"active_runs":1,...}]}

{"ok":true,"project":{"id":312,"created_via":"api",...},"links":{"added":2,"domain_errors":0}}

{"ok":true,"project":{"id":312,"links":[...],"runs":[...]}}

{"ok":true,"project":{...}}

{"ok":true,"deleted":true}

{"ok":true,"link":{"id":915,"url":"https://site.com/page",...},"links_count":4}

{"ok":true,"deleted":true}

Promotion (cascades) scope: promotion

{"ok":true,"tariffs":[{"id":3,"slug":"pro","name":"Pro","price_per_link":49.0,"cascade":{...}}],"your_discount_percent":10}

{"ok":true,"pricing_mode":"tariff","base_price":49.0,"discount_percent":10,"total":44.1,"balance":124.5,"sufficient_funds":true}

{"ok":true,"run_id":501,"status":"queued","charged":44.1,"discount_percent":10,"balance_after":80.4,"currency":"USD"}

{"ok":true,"runs":[{"id":501,"status":"level1_active","progress":{"done":3,"total":12,"pct":25},...}],"pagination":{...}}

{"ok":true,"run":{"id":501,"status":"level2_active","levels":[{"level":1,"total":5,"verified":5},...]}}

{"ok":true,"run_id":501,"nodes":[{"level":1,"network":"telegraph","url":"https://telegra.ph/…","verified":true,...}]}

Reports and white-label (Pro) scope: promotion

{"ok":true,"run":{...},"summary":{"verified":12,...},"report":{"level1":[...],"level2":[...],"crowd":[...]},"whitelabel":{...}} — или {"ok":true,"pdf":{"url":"…/uploads/reports/api-cascade-501-….pdf"},"branded":true}

{"ok":true,"is_pro":true,"branding_active":true,"branding":{"company_name":"Acme","logo_url":"…","accent_color":"#6366f1",...}}

{"ok":true,"branding":{...}}

Rank Tracker scope: rank

{"ok":true,"projects":[{"id":7,"domain":"site.com","region":"UA","keywords_count":50,"top10":12,...}]}

{"ok":true,"project":{"id":8,...}}

{"ok":true,"project":{...},"keywords":[{"id":91,"keyword":"buy windows","last_position":4,"last_checked_at":"…"}]}

{"ok":true,"added":25,"skipped":0}

{"ok":true,"queued":50,"note":"…"}

SEO Audit scope: audit

{"ok":true,"projects":[{"id":4,"domain":"site.com","start_url":"https://site.com/",...}]}

{"ok":true,"project":{"id":5,...}}

{"ok":true,"has_estimate":true,"estimated_pages":430,"full_audit_price":5.0,"currency":"USD"}

{"ok":true,"crawl_id":88,"mode":"full","max_pages":500,"charged":5.0}

{"ok":true,"crawl":{"id":88,"status":"done","health_score":79,"pages_crawled":430,"issues":{...}}}

{"ok":true,"crawls":[...]}

Security Shield scope: shield

{"ok":true,"projects":[{"id":3,"domain":"site.com","verified":true,...}]}

{"ok":true,"project":{"id":3,"verified":false,"verify_token":"pp-verify-…"},"verification_hint":"…"}

{"ok":true,"verified":true,"method":"dns"}

{"ok":true,"scan_id":41,"mode":"deep","charged":19.0}

{"ok":true,"scan":{"id":41,"status":"done","score":86,"grade":"B","verdict":{...},"findings_summary":{"critical":0,"high":1,...},"share_report_url":"…"}}

Code samples

cURL — create a project and launch promotion

curl -X POST https://promopilot.link/api/v1/projects \
  -H "Authorization: Bearer ppk_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Client Site",
    "url": "https://client-site.com",
    "language": "ru",
    "links": [{"url": "https://client-site.com/services", "anchor": "company services"}]
  }'

curl -X POST https://promopilot.link/api/v1/promotion/runs \
  -H "Authorization: Bearer ppk_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"project_id": 312, "url": "https://client-site.com/services"}'

PHP

<?php
$key = getenv('PROMOPILOT_API_KEY'); // never keep the key in your code
function pp_api(string $method, string $path, array $data = null) {
    global $key;
    $ch = curl_init('https://promopilot.link/api/v1' . $path);
    curl_setopt_array($ch, [
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_CUSTOMREQUEST => $method,
        CURLOPT_HTTPHEADER => [
            'Authorization: Bearer ' . $key,
            'Content-Type: application/json',
            'Accept-Language: ru',
        ],
        CURLOPT_POSTFIELDS => $data !== null ? json_encode($data) : null,
    ]);
    $res = json_decode(curl_exec($ch), true);
    $code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
    curl_close($ch);
    if (($res['ok'] ?? false) !== true) {
        throw new RuntimeException($res['error']['code'] ?? ('http_' . $code));
    }
    return $res;
}

$project = pp_api('POST', '/projects', ['name' => 'Client', 'url' => 'https://client-site.com']);
try {
    $run = pp_api('POST', '/promotion/runs', [
        'project_id' => $project['project']['id'],
        'url' => 'https://client-site.com/services',
    ]);
    echo "Started, run_id={$run['run_id']}, charged {$run['charged']}";
} catch (RuntimeException $e) {
    if ($e->getMessage() === 'insufficient_funds') {
        // top up the balance and retry
    }
}

Python

import os, requests

API = "https://promopilot.link/api/v1"
HEADERS = {"Authorization": f"Bearer {os.environ['PROMOPILOT_API_KEY']}"}

def api(method, path, **json_body):
    r = requests.request(method, API + path, headers=HEADERS, json=json_body or None, timeout=30)
    data = r.json()
    if not data.get("ok"):
        code = data.get("error", {}).get("code", f"http_{r.status_code}")
        if code == "insufficient_funds":
            details = data["error"]["details"]
            raise RuntimeError(f"Top up your balance: short by {details['shortfall']}")
        raise RuntimeError(code)
    return data

project = api("POST", "/projects", name="Client", url="https://client-site.com")
run = api("POST", "/promotion/runs", project_id=project["project"]["id"],
          url="https://client-site.com/services")
print("run_id:", run["run_id"], "charged:", run["charged"])

# Status polling
import time
while True:
    st = api("GET", f"/promotion/runs/{run['run_id']}")["run"]
    print(st["status"], st["progress"]["pct"], "%")
    if st["status"] in ("completed", "failed", "cancelled"):
        break
    time.sleep(60)

report = api("GET", f"/promotion/runs/{run['run_id']}/report")

Node.js

const API = "https://promopilot.link/api/v1";
const KEY = process.env.PROMOPILOT_API_KEY;

async function api(method, path, body) {
  const res = await fetch(API + path, {
    method,
    headers: {
      "Authorization": `Bearer ${KEY}`,
      "Content-Type": "application/json",
      "Accept-Language": "ru",
    },
    body: body ? JSON.stringify(body) : undefined,
  });
  const data = await res.json();
  if (!data.ok) {
    const code = data.error?.code || `http_${res.status}`;
    if (code === "insufficient_funds") {
      console.error("Top up your balance:", data.error.details.topup_url);
    }
    throw new Error(code);
  }
  return data;
}

const { project } = await api("POST", "/projects", { name: "Client", url: "https://client-site.com" });
const run = await api("POST", "/promotion/runs", { project_id: project.id, url: "https://client-site.com/services" });
console.log("run:", run.run_id, "charged:", run.charged);

OpenAPI

The full machine-readable specification for generating clients and importing into Postman/Insomnia: https://promopilot.link/api/v1/openapi.json

Questions and suggestions about the API go through support in the dashboard or Telegram. Backward compatibility: breaking changes ship only as a new version (/api/v2), and current fields are never removed without an announcement in the changelog.