---
title: "Get Match Result API"
method: GET
path: "/v1/match-result"
---

# Get Match Result API

`GET /v1/match-result`

## Request

- Base URL: `https://api.astrozop.com`
- URL: `https://api.astrozop.com/v1/match-result`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/gamezop/apis/astrozop-apis/docs/v1/match-result/get.ts> (a function with typed inputs; its response is checked against the schema)

This API allows you to pull data from Gamezop's systems for any multiplayer match played by your users.

## Query parameters

- `match_id` string, required

## Response `200`

HTTP 200 OK. Returns match result data for the requested match.

- MatchResultResponse
  - `data` MatchResultData
    - `property_id` string: Your Gamezop Property ID associated with the bearer token that you sent in the request.
    - `game_code` string: The Gamezop game code on which the match was played. You can get game codes for all Gamezop games enabled for you via the [All Games API](/publishers/gamezop/types-of-integration/all-games-api).
    - `room_id` string: The Room ID that you passed to us in the `roomDetails` object when [generating the game link](/publishers/gamezop/advanced/multiplayer-games#generating-game-links-for-multiplayer-games).
    - `match_id` string: The `match_id` that you're requesting data for.
    - `scores` MatchScore[]: Array of player score objects (one per participant). Each object includes `sub`, `is_bot`, `rank`, and `score`.
      - `sub` string: Your user identifier for the player. This is the identifier that you pass to us in the `roomDetails` object when [generating the game link](/publishers/gamezop/advanced/multiplayer-games#generating-game-links-for-multiplayer-games). Specifically, you pass this within the `user` object within `roomDetails`.
      - `is_bot` boolean: Whether the player was a bot.
      - `rank` integer: Player's rank within the match. Rank `1` is the winner.
      - `score` number: Player's latest score within that match.
    - `match_status` 'COMPLETED' | 'IN_PROGRESS': Match status.
    - `match_start_time` string, date-time: UTC timestamp representing the time at which the match started.
  - `success` boolean: Boolean value that is always `true`, unless there is an error in the API response.
  - `message` string: String value that is always empty, unless there is an error in the API response.

## Other responses

- `400`: Bad Request. Occurs when the `match_id` parameter is invalid or missing.
- `401`: Unauthorized. Occurs when the Bearer token is invalid or missing.

---

[API](https://skmtc.dev/gamezop/apis/astrozop-apis.md) - [All operations](https://skmtc.dev/gamezop/apis/astrozop-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/gamezop/apis/astrozop-apis/revisions/485db86a5145?raw)