Skip to content
YutaiDocs
GET /v1/statusGet API key

API reference / API reference

Check the API status

One call of the distributor API, read from the interface description Yutai publishes. Every sample answer on this page is simulated: no real holder's data stands behind it. The formats every value travels in are the identifiers page's.

View as .md

The call

GET/v1/statusCallable today

This call takes no key: you can call it before you hold one.

What it answers

Every external domain of Yutai's data, each with its mode today and the one sentence to show beside data in that mode, beside the overall word, the build the answer comes from and the server time. The call needs no key, because a distributor calls it before it holds one. A down answer names no modes, because the check failed before they could be read.

  • apiVersion

    Required. It always carries the value below.

    • 1

  • domains

    Required. A list of objects with the fields below.

    • Each item

      Required. An object with the fields below.

      • domain

        Required. A string that is one of the values below.

        • chain
        • openbanking
        • enrichment
        • prices
        • wallet
        • kyc-attest
        • registry
        • token-issuer-sources
        • reference-data
        • custodial
        • treasury

      • mode

        Required. A string that is one of the values below.

        • SIMULATED
        • SANDBOX
        • LIVE

      • sentence

        Required. A string. It carries at least 1 character.

  • status

    How the service stands: ok when it answers, degraded when part of it is unavailable, down when a check failed; a down word stands up to thirty seconds, so a recovered service can answer down briefly.

    Required. A string that is one of the values below.

    • ok
    • degraded
    • down

  • version

    The build this answer comes from: the first seven characters of the source commit, or unknown when the serving environment names none.

    Required. A string. It carries at least 1 character.

  • time

    The instant this answer was made, in the ISO 8601 form.

    Required. An instant in the ISO 8601 form.

The errors

Every refused call answers one object with one field, message: the plain sentence that says what did not happen. The sentence carries 1 to 512 characters, so a refusal never carries an id, a code or an exception's text.

The errors the call for GET /v1/status answers
StatusWhat it answers
500The read failed inside Yutai. Nothing was changed.

The errors and limits page carries every refusal status the document declares, each in its own words, beside the calls that answer it.