Modifiers' names and descriptions

GET/modifiers

Authorization

x-api-keyAPI key · headerrequired

Query parameters

idsstring

Comma-separated ids. Default: all.

Responses

200

dataModifier[]required

Show properties

Array of Modifier

idstringrequired

namestringrequired

descriptionstringrequired

targetstringrequired

Allowed:playerarenamatch

categorystring | nullrequired

Player modifiers only

Show properties

Any of:

string

string

null

null

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

Parameters

idsqueryComma-separated ids. Default: all.

Request

curl -X GET 'https://hockay.com/api/v1/modifiers' \
  -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/modifiers",
  headers: {
    "x-api-key": "YOUR_API_KEY",
    "Accept": "application/json"
  }
});

import requests

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

import Foundation

var request = URLRequest(url: URL(string: "https://hockay.com/api/v1/modifiers")!)
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": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "target": "player",
      "category": "positive"
    }
  ]
}

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

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

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