> For the complete documentation index, see [llms.txt](https://docs.pullbay.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pullbay.com/api-reference/readme.md).

# API Reference

## Authentication

Include your API key in the Authorization header:

```
Authorization: Bearer YOUR_API_KEY
```

Get your API key from the dashboard.

### Available services

| Service       | What you can access                                                          |
| ------------- | ---------------------------------------------------------------------------- |
| App Store     | iOS app lookup, search, similar apps, reviews, developer apps                |
| Google Play   | Android app lookup, search, similar apps, reviews, permissions, data safety  |
| Apartments    | Apartments.com properties, photos, and reviews                               |
| Google Maps   | Place search, place details, and reviews                                     |
| Google News   | Articles by category or search query                                         |
| Google Search | Web search results                                                           |
| DuckDuckGo    | Web search, images, news, videos                                             |
| Instagram     | Users, posts, reels, stories, and comments                                   |
| Reddit        | Posts, comments, users, and subreddits                                       |
| TikTok        | Users, posts, comments, hashtags, and search                                 |
| Twitter       | Tweets, users, handles, and search                                           |
| Yelp          | Places, reviews, and search                                                  |
| YouTube       | Channels, videos, shorts, live streams, comments, search, trending, hashtags |

Each service has its own reference page with full request/response schemas and examples.

### Quick example

```bash
# Fetch App Store reviews
curl "https://api.pullbay.com/appstore/reviews?app_id=284882215" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

```json
{
  "requestId": "3b8dcb68-1f8c-4a7b-b9e7-63a7b9986f24",
  "status": 200,
  "message": "OK",
  "success": true,
  "data": [
    {
      "id": "10293847561",
      "author": "HappyUser",
      "rating": 5,
      "title": "Great app!",
      "content": "This app has changed how I work...",
      "date": "2024-01-15T10:30:00Z",
      "version": "5.2.1"
    }
  ],
  "pagination": { "page": 1, "hasNextPage": true, "cursor": null, "offset": null },
  "pricing": { "creditsCharged": 2 }
}
```

This request cost 2 credits: 1 credit for the request + 1 credit for the item returned.

### Response format

All endpoints return the same envelope:

* `requestId` — unique ID for the request, useful when contacting support
* `status` / `message` / `success` — HTTP status, status text, and a boolean success flag
* `data` — the result(s)
* `pagination` — appears on list and search endpoints (`page`, `hasNextPage`, `cursor`, `offset`)
* `pricing.creditsCharged` — credits spent on the request

An `error` object is returned on failure.

### Pagination

List and search endpoints support two mutually exclusive modes on the same request:

* `page` — fetch one page at a time (fine control, fewer credits)
* `maxItems` — a one-shot bulk pull that the API pages through internally (simpler for batch jobs and automation)

Detail endpoints (e.g. app lookup, place details) return a single resource or a fixed set in one call, with no pagination.

### Need help?

* [**Documentation**](https://docs.pullbay.com/documentation/) — Guides and tutorials