ReferenceAPI ReferenceTransactions
List Inbound Transactions
List Inbound Transactions.
Request
interface TransactionsListInboundRequest {
action: 'get'
resource: '/inbound-transactions'
details?: {
limit: number | undefined
offset: number | undefined
sort_by: 'created_at' | 'updated_at' | undefined
sort: 'asc' | 'desc' | undefined
filters: {
wallet_ids: string[] | undefined
asset_id: string | undefined
} | undefined
} | undefined
}Prop
Type
Response
interface TransactionsListInboundResponse_success {
status: 'success'
error_code?: '-1' | '-2' | '-3' | '-4' | '-5' | '-6' | '-7' | '-8' | '-9' | '-10' | '-11' | '-12' | '-13' | undefined
message?: string | undefined
details: {
tx_type: 'issue' | 'send' | 'reissue' | 'burn' | undefined
txid: string
network: string
asset_ids: string[]
amount_sat: number
fee_sat: number
status: 'mempool' | 'confirmed' | 'rejected'
height: number | undefined
block_hash: string | undefined
block_time: string | undefined
wallet_ids: string[]
pset: string | undefined
spend_requests: string[] | undefined
unblinded_url: string
created_at: string
hex: string
vin: {
prev_txid: string
prev_vout: number
vin: number
asset_id: string
amount: number
wid: string | undefined
address: string | undefined
} []
vout: {
vout: number
asset_id: string
amount: number
wid: string | undefined
address: string | undefined
} []
} []
metadata: {
total_count: number
}
}Prop
Type
Example
import { resourceSchema } from '@blockstream/ecs-js-sdk'
import { broadcastRequest } from './broadcaster'
const response = await broadcastRequest<
typeof resourceSchema.shape.transactions.shape.list-inbound
>(
{
action: 'get',
resource: '/inbound-transactions',
details: {
// TODO: fill in required fields
},
},
blockstream,
)