Arenas and neutral sites

GET/arenas

Authorization

x-api-keyAPI key · headerrequired

Responses

200

dataArenasrequired

Show properties

arenasArena[]required

Show properties

Array of Arena

slugstringrequired

namestringrequired

nameTranslationstring | nullrequired

capacityintegerrequired

min -9007199254740991 · max 9007199254740991

lorestring | nullrequired

buildingstring | nullrequired

teamIdstringrequired

neutralSitesNeutralSite[]required

Show properties

Array of NeutralSite

slugstringrequired

namestringrequired

capacityintegerrequired

min -9007199254740991 · max 9007199254740991

locationstringrequired

announcementstring | nullrequired

lorestring | nullrequired

buildingstring | nullrequired

304

Not modified (If-None-Match matched the ETag)

401

Missing, unknown, revoked, or expired key

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

403

This account cannot use this key class

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

429

Rate limited; retry after the Retry-After seconds

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Request

curl -X GET 'https://hockay.com/api/v1/arenas' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Accept: application/json'

import axios from "axios";

const response = await axios.request({
  method: "GET",
  url: "https://hockay.com/api/v1/arenas",
  headers: {
    "x-api-key": "YOUR_API_KEY",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://hockay.com/api/v1/arenas",
    headers={
        "x-api-key": "YOUR_API_KEY",
        "Accept": "application/json"
    },
)

import Foundation

var request = URLRequest(url: URL(string: "https://hockay.com/api/v1/arenas")!)
request.httpMethod = "GET"
request.setValue("YOUR_API_KEY", forHTTPHeaderField: "x-api-key")
request.setValue("application/json", forHTTPHeaderField: "Accept")

let (data, response) = try await URLSession.shared.data(for: request)

Response

{
  "data": {
    "arenas": [
      {
        "slug": "string",
        "name": "string",
        "nameTranslation": "string",
        "capacity": -9007199254740991,
        "lore": "string",
        "building": "string",
        "teamId": "string"
      }
    ],
    "neutralSites": [
      {
        "slug": "string",
        "name": "string",
        "capacity": -9007199254740991,
        "location": "string",
        "announcement": "string",
        "lore": "string",
        "building": "string"
      }
    ]
  }
}

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string"
  }
}