# Utility Search Docs API (https://www.socialcrawl.dev/platforms/utility/docs-search)

> Search the developer docs and endpoint reference for a question and get the best-matching sections, ranked, each with a title, a link to its Markdown twin with an anchor (fetch the .md to read just that page), the page URL and a short snippet. Covers authentication, credits and refunds, pagination, errors, rate limits, caching, monitors, universal search and every endpoint. Pass platform to scope it to one platform, and limit for how many sections (default 5, up to 10). Free to call.

TL;DR: `GET /v1/utility/docs-search` costs Free (0 credits) and returns SocialCrawl's unified JSON schema. Single x-api-key auth, 100 free credits on signup.

## Parameters

| Parameter | Required | Description |
| --- | --- | --- |
| `query` | no | What to look up, in a few words or a question. Provide this or q |
| `q` | no | Short alias for query. Provide this or query |
| `platform` | no | Scope the search to one platform slug |
| `limit` | no | Sections to return, 1 to 10 (default 5) |

## Code example

```bash
curl -G "https://www.socialcrawl.dev/v1/utility/docs-search" \
  --data-urlencode "query=how does cursor pagination work" \
  -H "x-api-key: sc_YOUR_API_KEY"
```

## FAQ

### What does the Search Docs API return?

Returns the best-matching documentation sections for a question, ranked, each with a title, a Markdown link with an anchor, the page URL and a short snippet. The response uses the same JSON envelope as every SocialCrawl endpoint, with the data, credits_used and request_id fields.

### When should I use the Search Docs endpoint?

Use it to find the one docs page that answers a question about auth, credits, errors, rate limits or an endpoint, then read just that page. Free to call.

### How much does the Search Docs API cost?

This endpoint is free to call and uses no credits. Every new account still gets 100 free credits for the paid endpoints. Credits for failed or empty calls are refunded automatically, and there is no subscription.

### What parameters does the Search Docs API need?

Identify the target with one of query, q. It also accepts 4 optional parameters, all listed on this page.

### How do I call the Search Docs API?

Send a GET request to https://www.socialcrawl.dev/v1/utility/docs-search?query=how%20does%20cursor%20pagination%20work with your API key in the x-api-key header. An Authorization: Bearer header works too.

See the full Utility API: https://www.socialcrawl.dev/platforms/utility

## Pricing

- Standard endpoints: 1 credit per call
- Advanced endpoints: 5 credits per call
- Premium endpoints: 10 credits per call
- 100 free credits on signup, no credit card required. Cached responses cost 0 credits. Credit packs never expire.
- Full pricing: https://www.socialcrawl.dev/pricing

## Explore with AI

Questions this API answers, phrased for an AI assistant:

- What does the SocialCrawl Search Docs API return?
- How do I get Search Docs data with the SocialCrawl API?