> 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

This section contains the complete API reference for Pullbay. Browse available endpoints, view request/response schemas, and test API calls.

## Base URL

All API requests use this base URL:

```
https://api.pullbay.com/v1
```

## Authentication

Include your API key in the `Authorization` header:

```http
Authorization: Bearer YOUR_API_KEY
```

Get your API key from the [dashboard](https://app.pullbay.com).

## Available services

| Service              | Description                            | Status      |
| -------------------- | -------------------------------------- | ----------- |
| **App Store**        | iOS app reviews, ratings, metadata     | Available   |
| **Google Play**      | Android app reviews, ratings, metadata | Coming soon |
| **Google Search**    | SERP results, news, maps               | Coming soon |
| **YouTube**          | Video data, comments, channels         | Coming soon |
| **Review Platforms** | Trustpilot, Glassdoor, etc.            | Coming soon |

## Quick example

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

```json
{
  "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": {
    "next_cursor": "abc123",
    "has_more": true
  },
  "meta": {
    "credits_used": 1,
    "request_id": "req_xyz789"
  }
}
```

## Response format

All responses follow this structure:

| Field        | Description                                     |
| ------------ | ----------------------------------------------- |
| `data`       | The requested data (array or object)            |
| `pagination` | Pagination info (`next_cursor`, `has_more`)     |
| `meta`       | Request metadata (`credits_used`, `request_id`) |
| `error`      | Error details (only on failure)                 |

## Need help?

* [Documentation](https://github.com/epctex/pullbay-docs/blob/main/documentation/README.md) — Guides and tutorials
* [Getting Started](https://github.com/epctex/pullbay-docs/blob/main/documentation/getting-started/create-an-account.md) — Quick start guide
* [Help Center](https://github.com/epctex/pullbay-docs/blob/main/help-center/README.md) — FAQs and support


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.pullbay.com/api-reference/readme.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
