Blockstream Enterprise

Request

WalletsListUserWalletsRequest

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

Prop

Type

Response

WalletsListUserWalletsResponse_success

interface WalletsListUserWalletsResponse_success {
  status: 'success'
  error_code?: '-1' | '-2' | '-3' | '-4' | '-5' | '-6' | '-7' | '-8' | '-9' | '-10' | '-11' | '-12' | '-13' | undefined
  message?: string | undefined
  details: {
    wid: string
    id: string
    name: string | undefined
    type: 'amp' | 'kofn_multisig' | 'single_sig'
    descriptor: string
    k: number
    n: number
    locked: boolean
    address: string | undefined
    network: 'liquid' | 'bitcoin'
    slip77_hex: string | undefined
    created_at: string
    updated_at: string
    created_by: string
    updated_by: string
  } []
  metadata: {
    total_count: number
  }
}

Prop

Type

WalletsListUserWalletsResponse_failed | pending | unauthorized | rejected

interface WalletsListUserWalletsResponse_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

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

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

List User Wallets Wallets

Request

Response

Example

On this page