1. Create an API key
- Open Account settings → API.
- Give the key a name you will recognise later, such as “Reporting script”.
- Press Create key and copy it straight away — it is only shown once.
Keys start with rp_live_. You can hold up to 10 keys at a time, and revoking one stops it working immediately. Treat a key like a password: never put it in a public website, a shared document or browser code.
2. Call the API
Send your key on every request as a bearer token. The header x-api-key works too.
curl https://rank-pulse.com/api/public/v1/projects \ -H "Authorization: Bearer rp_live_…"
| Method | Path | What it returns |
|---|---|---|
| GET | /api/public/v1/me | The account the key belongs to. |
| GET | /api/public/v1/projects | Every project you own or that is shared with you. |
| GET | /api/public/v1/projects/{projectId} | Project summary: keyword count, how many rank, top-10 count, average position. |
| GET | /api/public/v1/projects/{projectId}/keywords | Keywords with their latest position and when they were last checked. |
| POST | /api/public/v1/projects/{projectId}/keywords | Add a keyword. Body: { keyword, country?, device?, location? } |
| GET | /api/public/v1/projects/{projectId}/competitors | Competitor domains tracked on the project. |
| GET | /api/public/v1/keywords/{keywordId}/ranks?limit=50 | Rank history for one keyword, newest first (limit 1–200). |
Example response
{
"projects": [
{
"id": "a15ad7b9-…",
"name": "example.com",
"domain": "example.com",
"created_at": "2026-05-28T21:31:54Z",
"archived": false
}
]
}Adding a keyword
curl -X POST https://rank-pulse.com/api/public/v1/projects/{projectId}/keywords \
-H "Authorization: Bearer rp_live_…" \
-H "Content-Type: application/json" \
-d '{"keyword":"moving company kelowna","country":"ca","device":"desktop"}'When something goes wrong
Errors come back as { "error": "…" } with one of these codes:
- 400 — something in your request was missing or invalid.
- 401 — the key is missing, mistyped or revoked.
- 403 — the key is valid but that project isn’t yours.
- 404 — no such project or keyword.
Team access applies exactly as it does in the app: shared projects are included, and viewers can read but not add keywords.
3. Connect with MCP (AI assistants)
MCP is the open standard AI assistants use to connect to tools. RankPulse ships a built-in MCP server that works with assistants like Claude, ChatGPT, Cursor and similar. No API key is involved: you sign in to RankPulse and approve the assistant once, and it then works as you.
MCP server address
https://rank-pulse.com/mcp- In your assistant, add a new connector / custom integration.
- Paste the address above.
- A RankPulse page opens — sign in if you aren’t already.
- Review what the assistant is asking for and press Approve.
Once connected, the assistant can:
list_projectsEvery project you can see.
get_projectSummary stats for one project.
list_keywordsKeywords and their latest positions.
get_keyword_ranksPosition history for one keyword.
list_competitorsCompetitor domains on a project.
add_keywordAdd a keyword to a project.
Try asking it: “Which keywords in my example.com project dropped this month?” or “Add ‘emergency plumber kelowna’ to my plumbing project.”
Good to know
- Rank checks triggered through either route use the same credits as the app.
- Data is read straight from your live account — no caching or delay.
- Revoking a key or removing the assistant connection cuts access instantly.
- Need something the list above doesn’t cover? Ask us from Help & Support inside the app.