Skip to content
Testnet only: a reference implementation, not a production service.Tokens and bank transfers here are simulated and have no value.

Public

6 operations under public. Examples read $API and $KEY from your shell.

GET /v1/public/issuer/{code}

Parameters

  • code string required in path

Responses

200 Default Response

object

  • object string required one of issuer_account
  • asset string required
  • asset_issuer string required
  • home_domain string required (nullable)
  • flags object required
    • auth_required boolean required
    • auth_revocable boolean required
    • auth_clawback_enabled boolean required
    • auth_immutable boolean required
  • read_at string required

Errors are RFC 9457 problem documents (application/problem+json).

curl

curl -s \
  "$API/v1/public/issuer/$CODE" \
  -H "authorization: Bearer $KEY"
Copied

SDK

import { createScrClient } from "@scr/sdk";

// The client sends the API key for you.
const client = createScrClient({ baseUrl: process.env.API!, apiKey: process.env.KEY! });
const { data, error } = await client.GET("/v1/public/issuer/{code}", {
  params: { path: { code: "<code>" } },
});
Copied

GET /v1/public/assets

Responses

200 Default Response

object

  • data array required

    Each item:

    • code string required
    • asset_issuer string required
    • asset_contract string required
    • currency string required
    • decimals number required one of 7

Errors are RFC 9457 problem documents (application/problem+json).

curl

curl -s \
  "$API/v1/public/assets" \
  -H "authorization: Bearer $KEY"
Copied

SDK

import { createScrClient } from "@scr/sdk";

// The client sends the API key for you.
const client = createScrClient({ baseUrl: process.env.API!, apiKey: process.env.KEY! });
const { data, error } = await client.GET("/v1/public/assets");
Copied

GET /v1/public/reserves/{code}

Parameters

  • code string required in path

Responses

200 Default Response

object

  • object string required one of reserve_report
  • asset string required
  • asset_issuer string required (nullable)
  • ledger_sequence integer required (nullable)
  • as_of string required
  • network string required one of testnet, other
  • simulated boolean required one of true
  • supply object required
    • total decimal string required
    • customer_held string required
    • buffer string required
    • frozen string required
    • liquidity_pool string optional Platform conversion-pool tokens (lp_inventory), excluded from customer_held. Omitted by snapshots published before this field existed: consumers treat a missing field as "0.0000000".
  • reserves object required
    • currency string required
    • total decimal string required
    • sources array required

      Each item:

      • id string required
      • kind string required one of off_chain
      • type string required
      • amount decimal string required
      • counted string required
      • fresh boolean required
      • as_of string required
      • max_age_seconds integer optional
      • evidence_ref string required (nullable)
  • inflight_reserved decimal string required
  • reserve_ratio decimal string required (nullable)
  • headroom string required
  • disclaimer string required

Errors are RFC 9457 problem documents (application/problem+json).

curl

curl -s \
  "$API/v1/public/reserves/$CODE" \
  -H "authorization: Bearer $KEY"
Copied

SDK

import { createScrClient } from "@scr/sdk";

// The client sends the API key for you.
const client = createScrClient({ baseUrl: process.env.API!, apiKey: process.env.KEY! });
const { data, error } = await client.GET("/v1/public/reserves/{code}", {
  params: { path: { code: "<code>" } },
});
Copied

GET /v1/public/supply/{code}

Parameters

  • code string required in path

Responses

200 Default Response

object

  • object string required one of supply_report
  • asset string required
  • asset_issuer string required (nullable)
  • ledger_sequence integer required (nullable)
  • as_of string required
  • network string required one of testnet, other
  • simulated boolean required one of true
  • total decimal string required
  • customer_held string required
  • buffer string required
  • frozen string required
  • liquidity_pool string optional Platform conversion-pool tokens (lp_inventory), excluded from customer_held. Omitted by snapshots published before this field existed: consumers treat a missing field as "0.0000000".
  • disclaimer string required

Errors are RFC 9457 problem documents (application/problem+json).

curl

curl -s \
  "$API/v1/public/supply/$CODE" \
  -H "authorization: Bearer $KEY"
Copied

SDK

import { createScrClient } from "@scr/sdk";

// The client sends the API key for you.
const client = createScrClient({ baseUrl: process.env.API!, apiKey: process.env.KEY! });
const { data, error } = await client.GET("/v1/public/supply/{code}", {
  params: { path: { code: "<code>" } },
});
Copied

GET /v1/public/snapshots

Parameters

  • asset string optional in query
  • limit integer required in query
  • starting_after string optional in query

Responses

200 Default Response

object

  • data array required

    Each item:

    • id string required
    • asset string required
    • ledger_sequence integer required
    • published_at string required
    • trigger string required one of operator, schedule
    • kid string required
    • url string required
    • pdf_url string required
    • jws string required
  • has_more boolean required

Errors are RFC 9457 problem documents (application/problem+json).

curl

curl -s \
  "$API/v1/public/snapshots?limit=1" \
  -H "authorization: Bearer $KEY"
Copied

SDK

import { createScrClient } from "@scr/sdk";

// The client sends the API key for you.
const client = createScrClient({ baseUrl: process.env.API!, apiKey: process.env.KEY! });
const { data, error } = await client.GET("/v1/public/snapshots", {
  params: { query: { limit: 1 } },
});
Copied

GET /v1/public/snapshots/{id}

Parameters

  • id string required in path

Responses

200 Default Response

object

  • object string required one of reserve_snapshot
  • id string required
  • ledger_sequence integer required
  • simulated boolean required one of true

Errors are RFC 9457 problem documents (application/problem+json).

curl

curl -s \
  "$API/v1/public/snapshots/$ID" \
  -H "authorization: Bearer $KEY"
Copied

SDK

import { createScrClient } from "@scr/sdk";

// The client sends the API key for you.
const client = createScrClient({ baseUrl: process.env.API!, apiKey: process.env.KEY! });
const { data, error } = await client.GET("/v1/public/snapshots/{id}", {
  params: { path: { id: "<id>" } },
});
Copied

Edit on GitHub