> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stophy.dev/llms.txt
> Use this file to discover all available pages before exploring further.
# Introduction
> Use the Stophy REST API: one base URL, bearer key authentication, a JSON body for every endpoint, and one flat response for every call.
**For AI agents:** use [llms.txt](https://docs.stophy.dev/llms.txt) for a full index of these docs.
Every Stophy endpoint uses the same base URL and bearer key. Data endpoints take a JSON body and return a consistent response.
## Features
Google results, news and images, and answers from AI assistants.
YouTube and TikTok videos, transcripts and comments.
Posts, profiles and comments from Reddit, Instagram, LinkedIn and Pinterest.
Google Maps and Tripadvisor places and reviews, flights and Airbnb.
Job listings from LinkedIn, Indeed and Upwork.
Walmart products and prices.
App Store and Google Play apps, reviews and charts.
Homes from Zillow, Rightmove and ImmoScout24.
Ad libraries from Meta, Google, TikTok, LinkedIn, Microsoft and Pinterest.
See every endpoint in the sidebar, grouped the same way.
## Base URL
```text theme={null}
https://api.stophy.dev
```
Every endpoint is a `POST` with a JSON object body. The path is `/v1/` plus the endpoint id with dots as slashes: `google.search` is `/v1/google/search`, and `transcript` is `/v1/transcript`. Unknown input fields return `400`.
## Authentication
Create a key in the [dashboard](https://stophy.dev/signup). Send it with every request:
```text theme={null}
Authorization: Bearer
```
```bash cURL icon="terminal" theme={null}
curl -X POST https://api.stophy.dev/v1/reddit/search \
-H "Authorization: Bearer $STOPHY_API_KEY" \
-H "content-type: application/json" \
-d '{"query":"bun runtime"}'
```
```ts TypeScript icon="https://mintcdn.com/sirathic/7E4w9-IC4ysabjfc/images/icons/typescript.svg?fit=max&auto=format&n=7E4w9-IC4ysabjfc&q=85&s=d8272a85e64145620f1fbbfcf7932986" theme={null}
const response = await fetch("https://api.stophy.dev/v1/reddit/search", {
method: "POST",
headers: {
authorization: "Bearer " + process.env.STOPHY_API_KEY,
"content-type": "application/json",
},
body: JSON.stringify({ query: "bun runtime" }),
});
```
```python Python icon="python" theme={null}
import os
import requests
response = requests.post(
"https://api.stophy.dev/v1/reddit/search",
headers={"Authorization": f"Bearer {os.environ['STOPHY_API_KEY']}"},
json={"query": "bun runtime"},
timeout=30,
)
```
An invalid or missing key returns `401` with code `unauthorized`.
## Responses
A successful call returns exactly `success`, `data`, `creditsUsed`, and `requestId`:
```json theme={null}
{
"success": true,
"data": {
"results": [{ "title": "Bun", "url": "https://bun.com/", "position": 1 }]
},
"creditsUsed": 1,
"requestId": "7db121ac-d8e6-479a-b17c-59e3fe5fabd8"
}
```
`data` is one flat object. A list is `data.results`, with `data.cursor` when there is another page. A value that belongs to something carries its owner in the name: `videoId`, `videoUrl`, `channelName`, `placeId`, `latitude`. Empty values are left out.
A failed call returns an error status and `{ "success": false, "error": { ... } }`. See [Errors](/api-reference/errors).
## One call, one page, one price
Each call returns one page and costs a fixed price, from 1 to 4 credits, whatever it returns. The exception is `transcript`: it costs 2 credits, or more when the audio has to be transcribed. See [Credits and billing](/billing). Endpoints that page take `page` (send `page: 2` while `data.hasMore` is true) or `cursor` (send back the `cursor` from the response). Endpoints without either return everything in one call. See [Page through results](/guides/paging).
Inputs are flat too. There are no nested option objects, and the JSON body is the only input: there is no output format to choose.
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.