# Stats API

> Stats API on Apizie: 28 endpoints (Halo 5 - Match Result - Arena, Halo 5 - Match Result - Campaign, Halo 5 - Company, Halo 5 - Company Commendations, …) 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://zieapi.vercel.app/v1/entertainment:haloapi-stats/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `entertainment:haloapi-stats`
- Category: Entertainment
- Status: byok
- Source: https://haloapi.com
- Page: https://zieapi.vercel.app/api/entertainment/haloapi-stats
- OpenAPI: https://zieapi.vercel.app/api/entertainment/haloapi-stats/openapi.json

API that provides statistical data about Players and Matches.

## Endpoints

### Halo 5 - Match Result - Arena
`GET https://zieapi.vercel.app/v1/entertainment:haloapi-stats/halo-5-match-result-arena` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| matchId | string | yes | An ID that uniquely identifies a Match. Match IDs can be retrieved from the "Halo 5 - Player Match History" Endpoint. |

### Halo 5 - Match Result - Campaign
`GET https://zieapi.vercel.app/v1/entertainment:haloapi-stats/halo-5-match-result-campaign` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| matchId | string | yes | An ID that uniquely identifies a Match. Match IDs can be retrieved from the "Halo 5 - Player Match History" Endpoint. |

### Halo 5 - Company
`GET https://zieapi.vercel.app/v1/entertainment:haloapi-stats/halo-5-company` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | The ID for the Company. The Company ID for a player can be retrieved from the Profile APIs via the "Halo 5 - Player Apperance" Endpoint. |

### Halo 5 - Company Commendations
`GET https://zieapi.vercel.app/v1/entertainment:haloapi-stats/halo-5-company-commendations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | The ID for the Company. The Company ID for a player can be retrieved from the Profile APIs via the "Halo 5 - Player Apperance" Endpoint. |

### Halo 5 - Match Result - Custom
`GET https://zieapi.vercel.app/v1/entertainment:haloapi-stats/halo-5-match-result-custom` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| matchId | string | yes | An ID that uniquely identifies a Match. Match IDs can be retrieved from the "Halo 5 - Player Match History" Endpoint. |

### Halo 5 - Match Result - Custom Local
`GET https://zieapi.vercel.app/v1/entertainment:haloapi-stats/halo-5-match-result-custom-local` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| matchId | string | yes | An ID that uniquely identifies a Match. Match IDs can be retrieved from the "Halo 5 - Player Match History" Endpoint. |

### Halo 5 - Match Events
`GET https://zieapi.vercel.app/v1/entertainment:haloapi-stats/halo-5-match-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| matchId | string | yes | An ID that uniquely identifies a Match. Match IDs can be retrieved from the "Halo 5 - Player Match History" Endpoint. |

### Halo 5 - Leaderboard - Player CSR
`GET https://zieapi.vercel.app/v1/entertainment:haloapi-stats/halo-5-leaderboard-player-csr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| seasonId | string | yes | The ID for the Season. |
| playlistId | string | yes | The ID for the Playlist. |
| count | number | no | When specified, this indicates the maximum quantity of items the client would like returned in the response. When omitted, 200 is assumed.… |

### Halo 5 - Player Commendations
`GET https://zieapi.vercel.app/v1/entertainment:haloapi-stats/halo-5-player-commendations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| player | string | yes | The Player's Gamertag. |

### Halo 5 - Player Match History
`GET https://zieapi.vercel.app/v1/entertainment:haloapi-stats/halo-5-player-match-history` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| player | string | yes | The Player's Gamertag. |
| modes | string | no | Indicates what Game Mode(s) the client is interested in getting Matches for (arena, campaign, custom, customlocal, or warzone). When the… |
| start | number | no | When specified, this indicates the starting index (0-based) for which the batch of results will begin at. For example, "start=0" indicates… |
| count | number | no | When specified, this indicates the maximum quantity of items the client would like returned in the response. When omitted, 25 is assumed.… |
| include-times | boolean | no | When set to "true", this indicates that the time component of the "MatchCompletedDate" field should be populated. Otherwise, when set to… |

### Halo 5 - Player Service Records - Arena
`GET https://zieapi.vercel.app/v1/entertainment:haloapi-stats/halo-5-player-service-records-arena` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| players | string | yes | A comma-separated list of Gamertags. Up to 32 Gamertags may be specified. |
| seasonId | string | no | When specified, this indicates the Season to request the Arena Playlist Stats for. If this is not specified, the default is the current… |

### Halo 5 - Player Service Records - Campaign
`GET https://zieapi.vercel.app/v1/entertainment:haloapi-stats/halo-5-player-service-records-campaign` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| players | string | yes | A comma-separated list of Gamertags. Up to 32 Gamertags may be specified. |

### Halo 5 - Player Service Records - Custom
`GET https://zieapi.vercel.app/v1/entertainment:haloapi-stats/halo-5-player-service-records-custom` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| players | string | yes | A comma-separated list of Gamertags. Up to 32 Gamertags may be specified. |

### Halo 5 - Player Service Records - Custom Local
`GET https://zieapi.vercel.app/v1/entertainment:haloapi-stats/halo-5-player-service-records-custom-local` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| players | string | yes | A comma-separated list of Gamertags. Up to 32 Gamertags may be specified. |

### Halo 5 - Player Service Records - Warzone
`GET https://zieapi.vercel.app/v1/entertainment:haloapi-stats/halo-5-player-service-records-warzone` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| players | string | yes | A comma-separated list of Gamertags. Up to 32 Gamertags may be specified. |

### Halo 5 - Match Result - Warzone
`GET https://zieapi.vercel.app/v1/entertainment:haloapi-stats/halo-5-match-result-warzone` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| matchId | string | yes | An ID that uniquely identifies a Match. Match IDs can be retrieved from the "Halo 5 - Player Match History" Endpoint. |

### Halo 5 PC - Match Result - Custom
`GET https://zieapi.vercel.app/v1/entertainment:haloapi-stats/halo-5-pc-match-result-custom` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| matchId | string | yes | An ID that uniquely identifies a Match. Match IDs can be retrieved from the "Halo 5 PC - Player Match History" Endpoint. |

### Halo 5 PC - Player Match History
`GET https://zieapi.vercel.app/v1/entertainment:haloapi-stats/halo-5-pc-player-match-history` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| player | string | yes | The Player's Gamertag. |
| modes | string | no | Indicates what Game Mode(s) the client is interested in getting Matches for (arena, campaign, custom, or warzone). When the parameter is… |
| start | number | no | When specified, this indicates the starting index (0-based) for which the batch of results will begin at. For example, "start=0" indicates… |
| count | number | no | When specified, this indicates the maximum quantity of items the client would like returned in the response. When omitted, 25 is assumed.… |
| include-times | boolean | no | When set to "true", this indicates that the time component of the "MatchCompletedDate" field should be populated. Otherwise, when set to… |

### Halo 5 PC - Player Service Records - Custom
`GET https://zieapi.vercel.app/v1/entertainment:haloapi-stats/halo-5-pc-player-service-records-custom` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| players | string | yes | A comma-separated list of Gamertags. Up to 32 Gamertags may be specified. |

### Halo Wars 2 - Match Result
`GET https://zieapi.vercel.app/v1/entertainment:haloapi-stats/halo-wars-2-match-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| matchId | string | yes | An ID that uniquely identifies a Match. Match IDs can be retrieved from the "Halo Wars 2 - Player Match History" Endpoint. |

### Halo Wars 2 - Match Events
`GET https://zieapi.vercel.app/v1/entertainment:haloapi-stats/halo-wars-2-match-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| matchId | string | yes | An ID that uniquely identifies a Match. Match IDs can be retrieved from the "Halo Wars 2 - Player Match History" Endpoint. |

### Halo Wars 2 - Leaderboard - Player CSR
`GET https://zieapi.vercel.app/v1/entertainment:haloapi-stats/halo-wars-2-leaderboard-player-csr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| seasonId | string | yes | The ID for the Season. |
| playlistId | string | yes | The ID for the Playlist. |
| count | number | no | When specified, this indicates the maximum quantity of items the client would like returned in the response. When omitted, 200 is assumed.… |

### Halo Wars 2 - Player Campaign Progress
`GET https://zieapi.vercel.app/v1/entertainment:haloapi-stats/halo-wars-2-player-campaign-progress` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| player | string | yes | The Player's Gamertag. |

### Halo Wars 2 - Player Match History
`GET https://zieapi.vercel.app/v1/entertainment:haloapi-stats/halo-wars-2-player-match-history` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| player | string | yes | The Player's Gamertag. |
| matchType | string | no | Indicates what Match Type the client is interested in getting Matches for ("custom" or "matchmaking"). When the parameter is omitted or… |
| start | number | no | When specified, this indicates the starting index (0-based) for which the batch of results will begin at. For example, "start=0" indicates… |
| count | number | no | When specified, this indicates the maximum quantity of items the client would like returned in the response. When omitted, 25 is assumed.… |

### Halo Wars 2 - Player Stats Summary
`GET https://zieapi.vercel.app/v1/entertainment:haloapi-stats/halo-wars-2-player-stats-summary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| player | string | yes | The Player's Gamertag. |

### Halo Wars 2 - Player Season Stats Summary
`GET https://zieapi.vercel.app/v1/entertainment:haloapi-stats/halo-wars-2-player-season-stats-summary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| player | string | yes | The Player's Gamertag. |
| seasonId | string | yes | A Season ID or "current" for the current Season. Seasons are available via the Metadata API. |

### Halo Wars 2 - Player Playlist Ratings
`GET https://zieapi.vercel.app/v1/entertainment:haloapi-stats/halo-wars-2-player-playlist-ratings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| playlistId | string | yes | The ID of the Playlist to get Ratings for. |
| players | string | yes | A comma-separated list of Gamertags. Up to 6 Gamertags may be specified. |

### Halo Wars 2 - Player XPs
`GET https://zieapi.vercel.app/v1/entertainment:haloapi-stats/halo-wars-2-player-xps` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| players | string | yes | A comma-separated list of Gamertags. Up to 6 Gamertags may be specified. |

## Example
```
curl "https://zieapi.vercel.app/v1/entertainment:haloapi-stats/halo-5-match-result-arena" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Stats API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/entertainment:haloapi-stats/halo-5-match-result-arena with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

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

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