# UGC API

> UGC API on Apizie: 4 endpoints (Halo 5 - Player Game Variants, Halo 5 - Player Game Variant, Halo 5 - Player Map Variants, Halo 5 - Player Map Variant) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/entertainment:haloapi-ugc/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `entertainment:haloapi-ugc`
- Category: Entertainment
- Status: byok
- Source: https://haloapi.com
- Page: https://apizie.tech/api/entertainment/haloapi-ugc
- OpenAPI: https://apizie.tech/api/entertainment/haloapi-ugc/openapi.json

API that provides Metadata about User-Generated Content (Maps and Game Variants).

## Endpoints

### Halo 5 - Player Game Variants
`GET https://apizie.tech/v1/entertainment:haloapi-ugc/58acde292109180bdcacc40d` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| player | string | yes | The Gamertag of the Player that owns the listed Game Variants. |
| start | number | no | When specified, this indicates the starting index (0-based) for which the list of results will begin at. |
| count | number | no | When specified, this indicates the maximum quantity of items the caller would like returned in the response. |
| sort | number | no | When specified, this indicates what field should be used to sort the results as the primary sort order. When omitted, "modified"… |
| order | number | no | When specified, this indicates the ordering that will be applied. When omitted, "desc" is assumed. Allowed order values are: asc, desc. |

### Halo 5 - Player Game Variant
`GET https://apizie.tech/v1/entertainment:haloapi-ugc/58acde292109180bdcacc40c` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| player | string | yes | The Gamertag of the Player that owns the Game Variant. |
| variant | string | yes | The ID for the Game Variant. |

### Halo 5 - Player Map Variants
`GET https://apizie.tech/v1/entertainment:haloapi-ugc/58acde292109180bdcacc40f` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| player | string | yes | The Gamertag of the Player that owns the listed Map Variants. |
| start | number | no | When specified, this indicates the starting index (0-based) for which the list of results will begin at. |
| count | number | no | When specified, this indicates the maximum quantity of items the caller would like returned in the response. |
| sort | number | no | When specified, this indicates what field should be used to sort the results as the primary sort order. When omitted, "modified"… |
| order | number | no | When specified, this indicates the ordering that will be applied. When omitted, "desc" is assumed. Allowed order values are: asc, desc. |

### Halo 5 - Player Map Variant
`GET https://apizie.tech/v1/entertainment:haloapi-ugc/58acde292109180bdcacc40e` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| player | string | yes | The Gamertag of the Player that owns the Map Variant. |
| variant | string | yes | The ID for the Map Variant. |

## Example
```
curl "https://apizie.tech/v1/entertainment:haloapi-ugc/58acde292109180bdcacc40d" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the UGC API?
Create a free Apizie key, then send GET https://apizie.tech/v1/entertainment:haloapi-ugc/58acde292109180bdcacc40d with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the UGC API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. UGC itself also needs your own key from haloapi.com.

### Can AI agents use the UGC API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key entertainment:haloapi-ugc.

### What is the status of the UGC API?
Needs your own provider key (bring your own key)