ReferenceAPI ReferenceAmp
Wallet Balance Amp
Wallet Balance Amp.
Request
interface AmpWalletBalanceRequest {
action: 'get'
resource: string
details: {
with_names: boolean
}
}Prop
Type
Response
interface AmpWalletBalanceResponse_success {
status: 'success'
error_code?: '-1' | '-2' | '-3' | '-4' | '-5' | '-6' | '-7' | '-8' | '-9' | '-10' | '-11' | '-12' | '-13' | undefined
message?: string | undefined
details: {
balances: unknown
}
metadata: unknown
}Prop
Type
Example
import { AmpActionsSchema } from '@blockstream/amp-js-sdk'
import { broadcastRequest } from './broadcaster'
const response = await broadcastRequest<
typeof AmpActionsSchema.shape.walletBalance
>(
{
action: 'get',
resource: '/amp/wallets/{walletId}/balance',
details: {
// TODO: fill in required fields
},
},
blockstream,
)