> 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/documentation/api-and-references/services-overview.md).

# Services Overview

Pullbay provides a unified API platform for accessing data from multiple sources through a single, consistent interface.

**Base URL:** `https://api.pullbay.com`\
**Authentication:** `Authorization: Bearer YOUR_API_KEY` (get your key from the dashboard)

## Available Services

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

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

## Response Format

All endpoints return the same envelope:

```json
{
  "requestId": "3b8dcb68-1f8c-4a7b-b9e7-63a7b9986f24",
  "status": 200,
  "message": "OK",
  "success": true,
  "data": [ /* ... */ ],
  "pagination": { "page": 1, "hasNextPage": null, "cursor": null, "offset": null },
  "pricing": { "creditsCharged": 2 }
}
```

`data` holds the result(s), `pagination` appears on list/search endpoints, `pricing.creditsCharged` reports the credits spent, and an `error` object is returned on failure.

## Endpoint Types & Pagination

* **Detail endpoints** return a single resource or a fixed set in one call, with no pagination (e.g. app lookup, place details).
* **List & search endpoints** support two mutually exclusive modes on the same request: `page` to fetch one page at a time (fine control, fewer credits), or `maxItems` for a one-shot bulk pull that the API pages through internally (simpler for batch jobs and automation).

## Credits

Each endpoint charges a **per-request cost + 1 credit per item returned**. The per-request amount varies by endpoint and is listed on each endpoint's page (App Store endpoints, for example, cost 1 credit per request + 1 credit per item). Monitor usage in the dashboard.

## Service Status

Operational status for every service is shown in your dashboard:

| Symbol | Status         | Impact                               |
| ------ | -------------- | ------------------------------------ |
| 🟢     | Operational    | No impact                            |
| 🟡     | Degraded       | Slower responses                     |
| 🟠     | Partial outage | Some requests may fail (often `503`) |
| 🔴     | Outage         | All requests fail                    |

For partial outages, implement retry logic with exponential backoff.

## FAQ

<details>

<summary><code>page</code> vs <code>maxItems</code>?</summary>

Use `page` to pull one page at a time with fine control over credits; use `maxItems` to fetch a full set in a single call. They're mutually exclusive.

</details>

<details>

<summary>Do I get historical data?</summary>

Yes — you get available historical data, not just recent items. The amount varies by platform and resource popularity.

</details>

<details>

<summary>Can I use Pullbay with n8n, Make, or Zapier?</summary>

Yes. Any platform that supports HTTP requests or webhooks works. See the n8n Integration Guide.

</details>

## Next Steps

* **Service reference pages** — full schemas and examples for each service
* **API Integration Guide** — integrating Pullbay into your backend
* **n8n Integration Guide** — automated workflows
