How do I use the SEOmise API?

Before you start

• Your plan needs API access. The Developer area is for owners and admins.
• Each kind of data needs its module in your plan: audits, issues and reports need the website health check, backlinks need Backlinks, and local data needs Google Business Profile.

Create a key

1. Open Developer → API keys and go to Create a key.
2. Name it after what will use it, for example "Client dashboard" or "Zapier".
3. Tick the scopes it needs: Sites, Audits, Issues, Backlinks, Local / GBP, Reports and Webhooks. Data scopes only read.
4. Optional: an Expires date and Allowed IP addresses (addresses or ranges, comma separated).
5. Press Create key and copy the key straight away. It is shown once; SEOmise stores only a hash of it.

Make a request

Send the key in the Authorization header:

curl -H "Authorization: Bearer smk_live_YOURKEY" https://your-seomise-address/api/public/v1/sites

The API reference tab lists every endpoint and scope. The full description is at /api/public/v1/openapi.json (OpenAPI 3.1), ready for Postman, Insomnia or a code generator.

Limits and errors

• Each key may make a number of requests a minute, set by your plan. Answers carry X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset. Over the limit you get 429 with Retry-After.
• 401: no key, an unknown key, or a revoked or expired one.
• 403: your address is not on the key's list, or the key lacks the scope.
• 402: not in your plan.

Rotate or revoke

Rotate gives a new token with the same settings; the old one stops working at once. Revoke stops a key for good. The Developer page shows your requests over the last 30 days.

Scores are SEOmise's measurements of your sites, not ranking guarantees.