Sparkscan API
Sparkscan API

Schemas

AddressSummaryResponse

  • sparkAddressstring · required
  • publicKeystring · required
  • balanceobject · required
  • totalValueUsdnumber · required
  • transactionCountinteger · required
  • tokenCountinteger · required
  • tokensarray | null

AddressToken

  • tokenIdentifierstring · required
  • tokenAddressstring · required
  • namestring · required
  • tickerstring · required
  • decimalsinteger · required
  • balanceinteger · required
  • valueUsdnumber · float · required
  • issuerPublicKeystring · required
  • maxSupplyinteger | null
  • isFreezableboolean | null

AddressTokensResponse

  • addressstring · required
  • pubkeystring · required
  • totalValueUsdnumber · float · required
  • tokensobject[] · required

AddressTransaction

  • idstring · required
  • typestring · enum · required
    Enum values:
    spark_transfer
    lightning_payment
    bitcoin_deposit
    bitcoin_withdrawal
    token_transfer
    token_mint
    token_burn
    token_multi_transfer
  • directionstring · enum · required
    Enum values:
    incoming
    outgoing
    creation
    destruction
    transfer
    deposit
    withdrawal
    payment
  • counterpartyobject · required
  • valueUsdnumber · float · required
  • statusstring · enum · required
    Enum values:
    confirmed
    pending
    sent
    failed
    expired
  • amountSatsinteger | null
  • tokenAmountinteger | null
  • createdAtstring | null · date-time

    When the transaction was first recorded/broadcast.

  • updatedAtstring | null · date-time

    Last update / completion timestamp.

  • txidstring | null
  • tokenMetadata | null
  • multiIoDetails | null

    Details for multi-input/output transactions

AddressTransactionsResponse

  • metaobject · required
  • dataobject[] · required

BalanceSummary

  • btcSoftBalanceSatsinteger · required
  • btcHardBalanceSatsinteger · required
  • btcValueUsdHardnumber · float · required
  • btcValueUsdSoftnumber · float · required
  • totalTokenValueUsdnumber · float · required

BatchTokenMetadataRequest

  • token_addressesstring[] · minItems: 1 · maxItems: 100 · required

    List of 66-character hex token addresses

BatchTokenMetadataResponse

  • metadataobject[] · required

    List of token metadata objects

  • total_countinteger · required

    Total number of tokens processed

BitcoinTxDetails

  • txidstring · required
  • vinobject[] · required
  • voutobject[] · required
  • statusobject · required
  • feeinteger · required

HTTPValidationError

  • detailobject[]

LatestNetworkTransactionItem

  • idstring · required

    Transaction ID (UUID for Spark/LN, hash for BTC/Token)

  • typestring · enum · required
    Enum values:
    bitcoin_deposit
    bitcoin_withdrawal
    spark_transfer
    lightning_payment
    token_mint
    token_transfer
    token_burn
    token_multi_transfer
  • statusstring · enum · required
    Enum values:
    confirmed
    pending
    sent
    failed
    expired
  • valueUsdnumber · float · required
  • createdAtstring | null · date-time

    When the transaction was first recorded/broadcast.

  • updatedAtstring | null · date-time

    Last update / completion timestamp.

  • amountSatsinteger | null
  • tokenAmountinteger | null
  • tokenMetadata | null
  • multiIoDetails | null

    Details for multi-input/output transactions

  • from | null
  • to | null
  • bitcoinTxidstring | null

MultiIoDetails

  • inputsobject[] · required

    List of input addresses and amounts

  • outputsobject[] · required

    List of output addresses and amounts

  • totalInputAmountinteger · required

    Sum of all input amounts

  • totalOutputAmountinteger · required

    Sum of all output amounts

TokenDetailsResponse

  • metadataobject · required
  • totalSupplyinteger · required
  • marketCapUsdnumber · float · required
  • volume24hUsdnumber · float · required

TokenHolder

  • addressstring · required
  • pubkeystring · required
  • balanceinteger · required
  • valueUsdnumber · float · required
  • percentagenumber · float · required

TokenHoldersResponse

  • metaobject · required
  • dataobject[] · required

TokenIoDetail

  • addressstring · required

    Spark address

  • pubkeystring · required

    Public key in hex

  • amountinteger · required

    Token amount

TokenIssuerLookupItem

  • pubkeystring | null
  • tokenIdentifierstring | null
  • tokenAddressstring | null

TokenIssuerLookupRequest

  • pubkeysarray | null · maxItems: 100
  • tokensarray | null · maxItems: 100

TokenIssuerLookupResponse

  • resultsobject[] · required

TokenMetadata

  • tokenIdentifierstring · required
  • tokenAddressstring · required
  • namestring · required
  • tickerstring · required
  • decimalsinteger · required
  • issuerPublicKeystring · required
  • iconUrlstring · required
  • holderCountinteger · required
  • priceUsdnumber · float · required
  • maxSupplyinteger | null
  • isFreezableboolean | null
  • createdAtstring | null · date-time
  • updatedAtstring | null · date-time

TokenTransaction

  • idstring · required
  • typestring · required

    Transaction type

    Example: token_transfer
  • statusstring · enum · required
    Enum values:
    confirmed
    pending
    sent
    failed
    expired
  • amountinteger · required

    Total output amount for the transaction

  • valueUsdnumber · float · required
  • tokenMetadataobject · required
  • createdAtstring | null · date-time

    When the transaction was first created/broadcast.

  • updatedAtstring | null · date-time

    Last update / completion timestamp.

  • from | null

    Sender information. May be null for multi-output transactions.

  • to | null

    Receiver information. May be null for multi-output transactions.

  • multiIoDetails | null

    Details for multi-input/output transactions

TokenTransactionMetadata

  • tokenIdentifierstring · required
  • tokenAddressstring · required
  • namestring · required
  • tickerstring · required
  • decimalsinteger · required
  • issuerPublicKeystring · required
  • maxSupplyinteger | null
  • isFreezableboolean | null

TokenTransactionsResponse

  • metaobject · required
  • dataobject[] · required

TransactionCounterparty

  • typestring · enum · required
    Enum values:
    spark
    lightning
    bitcoin
    token
  • identifierstring · required
  • tokenMetadata | null

TransactionMeta

  • totalItemsinteger · required
  • limitinteger · required
  • offsetinteger · required

TransactionParty

  • typestring · enum · required
    Enum values:
    spark
    lightning
    bitcoin
    issuer
    burn_address
    unknown
  • identifierstring · required
  • pubkeystring | null

TxStatus

  • confirmedboolean · required
  • block_height | null
  • block_time | null

TxV1Response

  • idstring · required
  • typestring · required
  • statusstring · enum · required
    Enum values:
    confirmed
    pending
    sent
    failed
    expired
  • amountSatsinteger · required
  • valueUsdnumber · float · required
  • createdAtstring | null · date-time

    When the transaction was first recorded/initiated.

  • updatedAtstring | null · date-time

    Last update / completion timestamp.

  • from | null
  • to | null
  • timeTakenSecondsnumber | null · float

    Duration of the transaction in seconds (from creation to completion). Null if start time is unavailable.

  • txidstring | null
  • bitcoinTxData | null

TxVin

  • prevout | null
  • witness | null
  • valueinteger

TxVout

  • valueinteger · required
  • scriptpubkey_address | null

ValidationError

  • locarray · required
  • msgstring · required
  • typestring · required