canonical: https://jentic.com/apis/sheerseo.com/sheerseo

# SheerSEO API

Sheerseo API has 2 stages:<br>First stage - initiating the task: You fill in your task and receive in return the task id. <br>Second stage - collecting the results: send a request containing the task ids you got at the first stage and collecting the results. The API exposes 4 endpoints secured with apiKey authentication.

## For AI agents

Programmatically rankcollect, ranksubmit. Covers 4 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for marketing only.

## Capabilities

- rankCollect
- rankSubmit
- serpCollect
- serpSubmit
- Monitor SheerSEO API operational status and events

## Use cases

### Marketing Operations

Use the SheerSEO API to perform marketing operations programmatically. The API provides 4 endpoints covering core functionality including rankcollect, ranksubmit, serpcollect.

Example prompt: Call POST /rank-collect to rankcollect

### Automated Rank Collect Management

Automate rank collect operations by combining multiple SheerSEO API endpoints. Agents can ranksubmit and then serpcollect in a single workflow.

Example prompt: Call POST /rank-submit to ranksubmit, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call SheerSEO API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'rankcollect', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/rank-collect` | rankCollect |
| POST | `/rank-submit` | rankSubmit |
| POST | `/serp-collect` | serpCollect |
| POST | `/serp-submit` | serpSubmit |

## Key resources

- **Rank Collect** — Operations for rank collect
- **Rank Submit** — Operations for rank submit
- **Serp Collect** — Operations for serp collect
- **Serp Submit** — Operations for serp submit
- **Swagger** — Operations for swagger

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 0 / 100
- **Maturity:** Non-Ready
- **Dimensions:**
  - Foundational Compliance: 100 / 100
  - Developer Experience & Jentic Compatibility: 78 / 100
  - AI-Readiness & Agent Experience: 43 / 100
  - Agent Usability: 94 / 100
  - Security: 15 / 100
  - AI Discoverability: 0 / 100
- **View full report:** https://jentic.com/apis/sheerseo.com/sheerseo/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the SheerSEO API by hand means appending your apiKey as a query parameter on the sheerseo.com host and managing the submit-then-collect flow for ranks and SERPs yourself. Through Jentic you install once, import the SheerSEO API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** SheerSEO takes its inputs in the request body rather than as path resources, so scope the agent to the operations it needs, such as submitting a rank job or collecting SERP results, and leave out the ones it should not run.
- **Credential handling:** Your SheerSEO API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'submit a rank tracking job' or 'collect SERP results', and Jentic returns the matching SheerSEO operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Mailchimp** — Alternative marketing API
- **Hubspot** — Alternative marketing API

## FAQ

### What authentication does the SheerSEO API use?

The SheerSEO API uses an API key passed in the `apiKey` query. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I rankcollect with the SheerSEO API?

Yes. Use the POST /rank-collect endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the SheerSEO API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I rankcollect through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'rankcollect'. Jentic returns the matching SheerSEO API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the SheerSEO API have?

The SheerSEO API exposes 4 endpoints covering rank collect, rank submit, serp collect operations.

### Can I limit what my agent is allowed to do with the SheerSEO API?

Yes. Jentic One is self-hosted by you, so your own rules decide which SheerSEO operations and credentials the agent may use. Because SheerSEO takes its inputs in the request body rather than as path resources, you scope the agent to just the operations it needs, such as submitting a rank job with POST /rank-submit and collecting its results with POST /rank-collect, while leaving out the SERP operations POST /serp-submit and POST /serp-collect. Your API key is injected only for the calls you have permitted, so the agent cannot run operations you have not allowed.