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. The call needs no key, because a distributor calls it before it holds one.

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.

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
Status	What it answers
500	The read failed inside Yutai. Nothing was changed.

The call, as a reader copies it: the key it presents stands where your own key stands, and the values are the sample answer's own.

curl "https://api.yutai.com/v1/status"

The sample answer for GET /v1/status

{
  "apiVersion": "1",
  "domains": [
    {
      "domain": "chain",
      "mode": "SIMULATED",
      "sentence": "This is simulated sample data for trying Yutai, not real records."
    },
    {
      "domain": "openbanking",
      "mode": "SIMULATED",
      "sentence": "This is simulated sample data for trying Yutai, not real records."
    },
    {
      "domain": "enrichment",
      "mode": "SIMULATED",
      "sentence": "This is simulated sample data for trying Yutai, not real records."
    },
    {
      "domain": "prices",
      "mode": "SIMULATED",
      "sentence": "This is simulated sample data for trying Yutai, not real records."
    },
    {
      "domain": "wallet",
      "mode": "SIMULATED",
      "sentence": "This is simulated sample data for trying Yutai, not real records."
    },
    {
      "domain": "kyc-attest",
      "mode": "SIMULATED",
      "sentence": "This is simulated sample data for trying Yutai, not real records."
    },
    {
      "domain": "registry",
      "mode": "SIMULATED",
      "sentence": "This is simulated sample data for trying Yutai, not real records."
    },
    {
      "domain": "token-issuer-sources",
      "mode": "SIMULATED",
      "sentence": "This is simulated sample data for trying Yutai, not real records."
    },
    {
      "domain": "reference-data",
      "mode": "SIMULATED",
      "sentence": "This is simulated sample data for trying Yutai, not real records."
    },
    {
      "domain": "custodial",
      "mode": "SIMULATED",
      "sentence": "This is simulated sample data for trying Yutai, not real records."
    },
    {
      "domain": "treasury",
      "mode": "SIMULATED",
      "sentence": "This is simulated sample data for trying Yutai, not real records."
    }
  ]
}