SERP it UP!

API

Use the SerpitUp API to pull rankings, competitor data, and account details into your own tools or agents. You need an API key from a signed-in account.

Base URL

https://serpitup.com/api/v1

Auth

Pass your key on every request:

Authorization: Bearer YOUR_API_KEY
# or
X-Api-Key: YOUR_API_KEY

Create keys after you sign in. Keep them private.

Responses

Success: { "data": { ... } }
Error:   { "error": { "code": "...", "message": "..." } }

Customer pages

Each URL below returns the same figures as the matching page on the site. {id} is the customer public_id from the website URL. Keyword, competitor, and snapshot ids work the same way.

Start with rankings. you is this customer's best domain. keywords is every phrase: position is the best listing on the latest saved Google result, positions is every listing, and score is #1 = 50 points down to #50 = 1. A null position means that phrase is not in the latest save. Older checks are on the keyword history endpoint.

  • GET /clients – companies on the account (Customers list)
  • GET /clients/{id}/dashboard – customer home: score, place, top domains, 90-day history
  • GET /clients/{id}/rankings – rankings scoreboard, your domains, and the keyword list
  • GET /clients/{id}/rankings/{domain} – one domain, one row per ranking URL
  • GET /clients/{id}/keywords – latest position, first_position, and position_change (+12 is 12 places higher). Optional ?q= and ?status=ranked|unranked
  • GET /clients/{id}/keywords/{keywordId} – organic pages, competitor board, and past checks
  • GET /clients/{id}/keywords/{keywordId}/history – position history. Optional ?market= public id
  • GET /clients/{id}/competitors – competitor scoreboard, including you
  • GET /clients/{id}/competitors/{competitorId} – competitor dossier
  • GET /clients/{id}/markets – search locations
  • GET /clients/{id}/profile – domains, notes, Search Console queries
  • GET /clients/{id} – full profile record (domains, keywords, competitors, markets)
  • GET /rankings/snapshots/{id} – one saved SERP

Example

curl -sS https://serpitup.com/api/v1/clients \
  -H "X-Api-Key: YOUR_API_KEY"

# Rankings scoreboard + where this customer ranks on each keyword
curl -sS https://serpitup.com/api/v1/clients/CLIENT_PUBLIC_ID/rankings \
  -H "X-Api-Key: YOUR_API_KEY"

# One keyword: pages on the latest SERP, your place, and older checks
curl -sS https://serpitup.com/api/v1/clients/CLIENT_PUBLIC_ID/keywords/KEYWORD_PUBLIC_ID \
  -H "X-Api-Key: YOUR_API_KEY"

OpenAPI

Sign in (or call with your API key) to download the OpenAPI file for codegen.

curl -sS https://serpitup.com/api/v1/openapi.json \
  -H "X-Api-Key: YOUR_API_KEY"

Customer sign-in