Skip to content
ajar.Get started

Rightmove authentication

Search properties without a Rightmove account. To use saved properties, saved searches, alerts or sent enquiries, send your own Rightmove token as well.

You need an ajar connector API token. Contact ajar for GB access. Dashboard API keys do not work with the connector API.

Which tools need a Rightmove account?

Guest: ajar token only. Account read: add your Rightmove token. Account write: also send an idempotency key.

ToolAccess
location.predictGuest
property.getGuest
property.searchGuest
alerts.listAccount read
saved_properties.listAccount read
saved_searches.listAccount read
sent_enquiries.listAccount read
alerts.createAccount write
alerts.deleteAccount write
alerts.updateAccount write
saved_properties.saveAccount write
saved_properties.unsaveAccount write
saved_searches.createAccount write
saved_searches.deleteAccount write

Tokens and headers

Every request · Your ajar connector API token

Authorization: Bearer YOUR_CONNECTOR_TOKEN

Account tools only · Your Rightmove login token (sso2)

x-rightmove-token: YOUR_RIGHTMOVE_SSO2_TOKEN

Try a guest request

Find a location using only your ajar token. No Rightmove login is needed.

Command
curl 'https://api.useajar.com/v1/operations/rightmove.location.predict' \
  -H 'Authorization: Bearer YOUR_CONNECTOR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data '{"query":"London","limit":5}'

Use your Rightmove account

Get your sso2 token through your own Rightmove login. Keep it on your device and send it in x-rightmove-token. ajar does not store it.

Command
curl 'https://api.useajar.com/v1/operations/rightmove.saved_properties.list' \
  -H 'Authorization: Bearer YOUR_CONNECTOR_TOKEN' \
  -H 'x-rightmove-token: YOUR_RIGHTMOVE_SSO2_TOKEN' \
  -H 'Content-Type: application/json' \
  --data '{"size":25}'

Make a change

Write access must be enabled for your ajar caller. Confirm the action, then send a unique x-idempotency-key for that attempt. Replace the example property ID with one returned by search. If a write has an uncertain outcome, read the current state before trying again; do not blindly repeat it with a new key.

Command
curl 'https://api.useajar.com/v1/operations/rightmove.saved_properties.save' \
  -H 'Authorization: Bearer YOUR_CONNECTOR_TOKEN' \
  -H 'x-rightmove-token: YOUR_RIGHTMOVE_SSO2_TOKEN' \
  -H 'x-idempotency-key: YOUR_UNIQUE_ATTEMPT_KEY' \
  -H 'Content-Type: application/json' \
  --data '{"property_id":123456789}'

Use the CLI

With the ajar CLI installed, save your ajar connector token at the hidden prompt, then import your Rightmove token from stdin. Tokens stay in your OS credential store. Local sign-out removes the saved Rightmove token.

Command
ajar auth login-connector --api-url https://api.useajar.com
ajar rightmove use-token --token-stdin < /path/to/rightmove-token.txt
ajar rightmove sign-out

When your token expires

If an account request returns auth_expired, log in to Rightmove again and replace your token. No automatic refresh is available. Guest requests still need only your ajar token.

Optional sign-in helper

Already completed the Arkose challenge yourself? You can submit email, password and captchaToken to this helper. It returns access_token, token_type: sso2 and consumer_uuid for you to keep. It does not display or solve the challenge. You can also submit this JSON using ajar rightmove sign-in --credentials-stdin.

Request
POST https://api.useajar.com/v1/connections/rightmove/sign-in
Authorization: Bearer YOUR_CONNECTOR_TOKEN
Content-Type: application/json

{"email":"you@example.com","password":"YOUR_PASSWORD","captchaToken":"YOUR_COMPLETED_CHALLENGE_TOKEN"}
Authentication guide