Blockstream Enterprise
ReferenceAPI ReferenceAssets

List Assets

List Assets.

Request

AssetsListRequest
interface AssetsListRequest {
  action: 'get'
  resource: '/assets'
  details?: {
    limit: number | undefined
    offset: number | undefined
    sort_by: 'created_at' | 'updated_at' | undefined
    sort: 'asc' | 'desc' | undefined
  } | undefined
}

Prop

Type

Response

AssetsListResponse_success
interface AssetsListResponse_success {
  status: 'success'
  error_code?: '-1' | '-2' | '-3' | '-4' | '-5' | '-6' | '-7' | '-8' | '-9' | '-10' | '-11' | '-12' | '-13' | undefined
  message?: string | undefined
  details: {
    aid: string
    issuer_wid: string | undefined
    name: string
    ticker: string
    domain: string | undefined
    version: number | undefined
    precision: number
    circulating_amount: string
    issued_amount: number
    locked: boolean
    is_amp: boolean
    registration_status: string | undefined
    reissuance_token_id: string | undefined
    issuer_pubkey: string | undefined
    coingecko_id: string | undefined
  } []
  metadata: {
    total_count: number
  }
}

Prop

Type

AssetsListResponse_failed | pending | unauthorized | rejected
interface AssetsListResponse_failed | pending | unauthorized | rejected {
  status: 'failed' | 'pending' | 'unauthorized' | 'rejected'
  error_code?: '-1' | '-2' | '-3' | '-4' | '-5' | '-6' | '-7' | '-8' | '-9' | '-10' | '-11' | '-12' | '-13' | undefined
  message?: string | undefined
}

Prop

Type

Example

Example
import { resourceSchema } from '@blockstream/ecs-js-sdk'
import { broadcastRequest } from './broadcaster'

const response = await broadcastRequest<
  typeof resourceSchema.shape.assets.shape.list
>(
  {
    action: 'get',
    resource: '/assets',
    details: {
      // TODO: fill in required fields
    },
  },
  blockstream,
)

On this page