osrs-data-hub
Key

The key and its creator

GET
/me

The key behind the request (kind, name, prefix, categories, scope, rate limit, expiry), its creator’s display name (user, null for a service key) and how many accounts it can see right now. Handy as a connection test.

Authorization

bearerAuth
AuthorizationBearer <token>

An API key from the hub’s API keys page.

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/me"
{  "data": {    "key": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "kind": "user",      "name": "string",      "prefix": "string",      "categories": [        "stats"      ],      "account_scope": "all_visible",      "rate_limit_per_minute": 1,      "expires_at": "2019-08-24T14:15:22Z"    },    "user": {      "name": "string"    },    "visible_accounts": 0  },  "meta": {    "generated_at": "2019-08-24T14:15:22Z"  }}

API overview

Authentication, conventions, limits and errors of the hub's read-only REST API (v1).

List visible accounts GET

Every account the key may see, sorted by name, each with its `owner` (the active owner as the guild page shows them, or null) and, for service keys, its `account_hash`. `online`, `world` and `last_seen` are null for accounts whose `activity` the key can’t read. `meta.count` is the number returned.