# Zgdypw — Wrapped API

> **You are on:** `https://api.paywithlocus.com/api` | [llms.txt](https://paywithlocus.com/llms.txt) | [docs](https://docs.paywithlocus.com)
>
> Locus runs on multiple environments -- make sure every URL you call matches your expected environment.
> | Environment | Landing | API | Docs |
> |---|---|---|---|
> | Production | paywithlocus.com | api.paywithlocus.com | docs.paywithlocus.com |
> | Beta | beta.paywithlocus.com | api.beta.paywithlocus.com | docs.paywithlocus.com |
> | Stage | stage.paywithlocus.com | api.stage.paywithlocus.com | docs.paywithlocus.com |
>
> If the API URL above doesn't match your expected environment, re-fetch this file from the correct domain.

> Track China's movie box office performance with daily rankings by movie, cinema, circuit, and city, plus access detailed weekly and monthly reports for comprehensive market analysis. Monitor industry trends through curated market analysis articles and reports to stay informed on the Chinese film industry's performance and growth.

**Category:** Entertainment | **Website:** [zgdypw.cn/](https://zgdypw.cn/) | **Docs:** [parse.bot/marketplace/2c483492-1cc5-48c5-a567-8cb690ec9ac8/zgdypw-cn-api](https://parse.bot/marketplace/2c483492-1cc5-48c5-a567-8cb690ec9ac8/zgdypw-cn-api)

Pay-per-use API proxy for Locus Pro. Each call burns credits from your workspace balance.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/credits/zgdypw/`
**Auth:** `Authorization: Bearer <LOCUS_CREDITS_SECRET_KEY>` (an `lcr_` secret key or a scoped `lcac_` agent credential)
**Required header:** `Idempotency-Key: <fresh UUID per call>`. A retry with the same key replays the stored result without a new charge.
**Response:** the provider response after any endpoint-specific normalization. `X-Locus-Credits-Charged` carries the charge and `X-Locus-Credits-Balance` the remaining balance. Insufficient credits return `402` before the provider is called.
**Pricing:** estimated costs below are USD. Locus debits the credit equivalent at your workspace rate.

Full call contract: https://docs.paywithlocus.com/api-reference/introduction

> Using a Pay With Locus wallet key (`claw_` prefix)? Wallet routes are documented separately: https://docs.paywithlocus.com/wrapped-apis/for-agents

## Endpoints

### Get daily box office cinemas

Fetch current daily box office data for cinemas. Returns top 10 cinemas ranked by daily sales with their name, total sales, session count, and audience count.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/zgdypw/get-daily-box-office-cinemas \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### Get daily box office circuits

Fetch current daily box office data for cinema circuits/chains. Returns top 10 circuits ranked by daily sales with their name, total sales, session count, and audience count.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/zgdypw/get-daily-box-office-circuits \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### Get daily box office cities

Fetch current daily box office data for cities. Returns top 10 cities ranked by daily sales with their name, total sales, session count, and audience count.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/zgdypw/get-daily-box-office-cities \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### Get daily box office movies

Fetch current daily box office data for movies. Returns top 10 movies ranked by daily sales and a real-time market summary including total box office revenue, audience count, cinema count, and session count. Data updates throughout the business day.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/zgdypw/get-daily-box-office-movies \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### Get market analysis article

Fetch and parse a specific market analysis article. Returns full article text content including province-level box office analysis. The URL must be obtained from list_market_analysis_articles.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `url` | string | Yes | Full URL of the market analysis article, obtained from list_market_analysis_articles results |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/zgdypw/get-market-analysis-article \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"url":"<string>"}'
```

### Get monthly box office report

Fetch and parse a specific monthly box office report article. These reports are image-based, returning the report title and image URLs of the report charts. The URL must be obtained from list_data_reports or list_monthly_reports.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `url` | string | Yes | Full URL of the monthly report article, obtained from list_data_reports or list_monthly_reports results |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/zgdypw/get-monthly-box-office-report \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"url":"<string>"}'
```

### Get new cinemas monthly report

Fetch and parse a market info article, typically a monthly new cinemas report. New cinemas reports contain structured table data listing newly opened cinemas with their names, locations, screen counts, and opening dates. The URL must be obtained from list_market_info_articles.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `url` | string | Yes | Full URL of the market info article, obtained from list_market_info_articles results |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/zgdypw/get-new-cinemas-monthly-report \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"url":"<string>"}'
```

### Get weekly box office report

Fetch and parse a specific weekly box office report article. These reports are image-based. The URL must be obtained from list_data_reports or list_weekly_reports; older URLs may return 404.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `url` | string | Yes | Full URL of the weekly report article, obtained from list_data_reports or list_weekly_reports results |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/zgdypw/get-weekly-box-office-report \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"url":"<string>"}'
```

### List data reports

Fetch the paginated list of all data reports (monthly and weekly box office reports). Each page returns up to 10 reports with their titles, publication dates, and article URLs. Navigate pages to access older reports.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `page` | integer | No | Page number (1-indexed) |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/zgdypw/list-data-reports \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"page":"<integer>"}'
```

### List market analysis articles

Fetch the paginated list of market analysis articles. Returns article titles, publication dates, and URLs. Articles contain province-level box office analysis and weekly market summaries.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `page` | integer | No | Page number (1-indexed) |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/zgdypw/list-market-analysis-articles \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"page":"<integer>"}'
```

### List market info articles

Fetch the paginated list of market information articles including new cinema reports and movie announcements. Each page returns up to 10 articles.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `page` | integer | No | Page number (1-indexed) |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/zgdypw/list-market-info-articles \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"page":"<integer>"}'
```

### List monthly reports

Fetch only the monthly box office reports from the data reports listing, filtered by title containing the monthly report keyword (月报). Returns a subset of list_data_reports results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `page` | integer | No | Page number (1-indexed) |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/zgdypw/list-monthly-reports \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"page":"<integer>"}'
```

### List weekly reports

Fetch only the weekly box office reports from the data reports listing, filtered by title containing the weekly report keyword (周报). Returns a subset of list_data_reports results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `page` | integer | No | Page number (1-indexed) |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/zgdypw/list-weekly-reports \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"page":"<integer>"}'
```

## Next steps

- [All wrapped API providers](https://paywithlocus.com/wapi/index.md): pick another provider.
- [Find and call tools](https://paywithlocus.com/agent/tools.md): price ceilings, async results, and errors.
- [Credits and billing](https://paywithlocus.com/agent/billing.md): what a call costs and how to add credits.
- [Agent docs index](https://paywithlocus.com/agent/index.md): every Locus agent page.