API reference · Status

Service status

GET/v1/status

Whether the API is up and whether trading and gift cards are enabled, plus the server clock. No signature needed. Cached for up to 30 s.

Scope
None. This endpoint needs no signature.
Rate-limit class
None (cached)
Authentication
None

Responses

200 OK

The status. application/json · Status

  • statusstring (enum)

    ok; maintenance: read-only, writes are refused; down: the API is switched off or unreachable.

    One of ok, maintenance, down.

  • read_onlyboolean
  • trading_enabledboolean
  • giftcards_enabledboolean
  • withdrawals_enabledboolean
  • server_timestring (date-time)

    The server clock. Signed requests must be within 30 s of it.

Every response carries MK-Request-Id.

Errors

Errors use the error envelope. Match on code.

StatusCodeMeaning
400invalid_requestThe request is malformed: bad JSON, an unknown or invalid field, or a missing header.
500internal_errorSomething went wrong on our side.
503overloadedThe service is overloaded. Retry after Retry-After seconds.

Request

curl https://public-api.myntkaup.is/v1/status
import { Myntkaup } from "@myntkaup/api";

const client = new Myntkaup(); // reads the key from the environment
const status = await client.status();
console.log(status.trading_enabled, status.server_time);
from myntkaup import Myntkaup

client = Myntkaup()  # reads the key from the environment
status = client.status()
print(status["trading_enabled"], status["server_time"])

Response

200 OK
{
  "status": "ok",
  "read_only": false,
  "trading_enabled": true,
  "giftcards_enabled": true,
  "withdrawals_enabled": true,
  "server_time": "2026-11-03T10:15:10.123Z"
}

Base URL https://public-api.myntkaup.is