Sparkscan API

Tx

Endpointhttps://api.sparkscan.io

Download schema

Operations related to transactions

GET

https://api.sparkscan.io

/v1/tx/latest

query Parameters

network

string · enum

Enum values:

MAINNET

REGTEST

limit

min: 1

Maximum number of transactions to return. Limit is 350.

offset

min: 0

sort

string · enum

Enum values:

created_at

updated_at

order

string · enum

Enum values:

asc

desc

from_timestamp

string

to_timestamp

string

Responses

Response for status 200

object[]

id

string · required

type

string · enum · required

Enum values:

bitcoin_deposit

bitcoin_withdrawal

spark_transfer

lightning_payment

token_mint

token_transfer

token_burn

token_multi_transfer

status

string · enum · required

Enum values:

confirmed

pending

sent

failed

expired

valueUsd

number · required

GET/v1/tx/latest

curl --request GET \
  --url https://api.sparkscan.io/v1/tx/latest

shell

Example Responses

[
  {
    "id": "id",
    "type": "bitcoin_deposit",
    "status": "confirmed",
    "amountSats": 0,
    "tokenAmount": "string",
    "tokenMetadata": {
      "tokenIdentifier": "tokenIdentifier",
      "tokenAddress": "tokenAddress",
      "name": "name",
      "ticker": "ticker",
      "decimals": 0,
      "issuerPublicKey": "issuerPublicKey",
      "maxSupply": "string",
      "isFreezable": true
    },
    "multiIoDetails": {
      "inputs": [
        {
          "address": "address",
          "pubkey": "pubkey",
          "amount": "amount"
        }
      ],
      "outputs": [
        {
          "address": "address",
          "pubkey": "pubkey",
          "amount": "amount"
        }
      ],
      "totalInputAmount": "totalInputAmount",
      "totalOutputAmount": "totalOutputAmount"
    },
    "from": {
      "type": "spark",
      "identifier": "identifier",
      "pubkey": "string"
    },
    "to": {
      "type": "spark",
      "identifier": "identifier",
      "pubkey": "string"
    },
    "bitcoinTxid": "string",
    "valueUsd": 0,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
]

json

application/json

GET

https://api.sparkscan.io

/v1/tx/{txid}

path Parameters

txid

string · required

query Parameters

network

string · enum

Enum values:

MAINNET

REGTEST

Responses

Response for status 200

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object · requires: id, type, status +2 more
	type = object · requires: id, type, status +2 more

Properties for Variant 1:

id

string · required

type

string · required

required

amountSats

integer · required

valueUsd

number · required

GET/v1/tx/{txid}

curl --request GET \
  --url https://api.sparkscan.io/v1/tx/:txid

shell

Example Responses

{
  "id": "id",
  "type": "type",
  "status": "confirmed",
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z",
  "from": {
    "type": "spark",
    "identifier": "identifier",
    "pubkey": "string"
  },
  "to": {
    "type": "spark",
    "identifier": "identifier",
    "pubkey": "string"
  },
  "amountSats": 0,
  "valueUsd": 0,
  "timeTakenSeconds": 0,
  "txid": "string",
  "bitcoinTxData": {
    "txid": "txid",
    "vin": [
      {
        "prevout": {},
        "witness": [
          "string"
        ],
        "value": 0
      }
    ],
    "vout": [
      {
        "scriptpubkey_address": "string",
        "value": 0
      }
    ],
    "status": {
      "confirmed": true,
      "block_height": 0,
      "block_time": 0
    },
    "fee": 0
  }
}

json

application/json

GET

https://api.sparkscan.io

/v1/address/{address}/transactions

path Parameters

address

string · required

query Parameters

network

string · enum

Enum values:

MAINNET

REGTEST

limit

min: 1 · max: 100

offset

min: 0

asset

string

sort

string · enum

Enum values:

created_at

updated_at

order

string · enum

Enum values:

asc

desc

from_timestamp

string

to_timestamp

string

Responses

Response for status 200

object · required

object[] · required

GET/v1/address/{address}/transactions

curl --request GET \
  --url https://api.sparkscan.io/v1/address/:address/transactions

shell

Example Responses

{
  "meta": {
    "totalItems": 0,
    "limit": 0,
    "offset": 0
  },
  "data": [
    {
      "id": "id",
      "type": "spark_transfer",
      "direction": "incoming",
      "counterparty": {
        "type": "spark",
        "identifier": "identifier",
        "tokenMetadata": {
          "tokenIdentifier": "tokenIdentifier",
          "tokenAddress": "tokenAddress",
          "name": "name",
          "ticker": "ticker",
          "decimals": 0,
          "issuerPublicKey": "issuerPublicKey",
          "maxSupply": "string",
          "isFreezable": true
        }
      },
      "amountSats": 0,
      "tokenAmount": "string",
      "valueUsd": 0,
      "createdAt": "2024-08-25T15:00:00Z",
      "updatedAt": "2024-08-25T15:00:00Z",
      "status": "confirmed",
      "txid": "string",
      "tokenMetadata": {
        "tokenIdentifier": "tokenIdentifier",
        "tokenAddress": "tokenAddress",
        "name": "name",
        "ticker": "ticker",
        "decimals": 0,
        "issuerPublicKey": "issuerPublicKey",
        "maxSupply": "string",
        "isFreezable": true
      },
      "multiIoDetails": {
        "inputs": [
          {
            "address": "address",
            "pubkey": "pubkey",
            "amount": "amount"
          }
        ],
        "outputs": [
          {
            "address": "address",
            "pubkey": "pubkey",
            "amount": "amount"
          }
        ],
        "totalInputAmount": "totalInputAmount",
        "totalOutputAmount": "totalOutputAmount"
      }
    }
  ]
}

json

application/json

GET

https://api.sparkscan.io

/v1/tokens/{identifier}/holders

path Parameters

identifier

string · required

query Parameters

network

string · enum

Enum values:

MAINNET

REGTEST

limit

offset

Responses

Response for status 200

object · required

object[] · required

GET/v1/tokens/{identifier}/holders

curl --request GET \
  --url https://api.sparkscan.io/v1/tokens/:identifier/holders

shell

Example Responses

{
  "meta": {
    "totalItems": 0,
    "limit": 0,
    "offset": 0
  },
  "data": [
    {
      "address": "address",
      "pubkey": "pubkey",
      "balance": "balance",
      "valueUsd": 0,
      "percentage": 0
    }
  ]
}

json

application/json

GET

https://api.sparkscan.io

/v1/tokens/{identifier}/transactions

path Parameters

identifier

string · required

query Parameters

network

string · enum

Enum values:

MAINNET

REGTEST

limit

offset

Responses

Response for status 200

object · required

object[] · required

GET/v1/tokens/{identifier}/transactions

curl --request GET \
  --url https://api.sparkscan.io/v1/tokens/:identifier/transactions

shell

Example Responses

{
  "meta": {
    "totalItems": 0,
    "limit": 0,
    "offset": 0
  },
  "data": [
    {
      "id": "id",
      "type": "type",
      "status": "confirmed",
      "createdAt": "2024-08-25T15:00:00Z",
      "updatedAt": "2024-08-25T15:00:00Z",
      "from": {
        "type": "spark",
        "identifier": "identifier",
        "pubkey": "string"
      },
      "to": {
        "type": "spark",
        "identifier": "identifier",
        "pubkey": "string"
      },
      "amount": "amount",
      "valueUsd": 0,
      "tokenMetadata": {
        "tokenIdentifier": "tokenIdentifier",
        "tokenAddress": "tokenAddress",
        "name": "name",
        "ticker": "ticker",
        "decimals": 0,
        "issuerPublicKey": "issuerPublicKey",
        "maxSupply": "string",
        "isFreezable": true
      },
      "multiIoDetails": {
        "inputs": [
          {
            "address": "address",
            "pubkey": "pubkey",
            "amount": "amount"
          }
        ],
        "outputs": [
          {
            "address": "address",
            "pubkey": "pubkey",
            "amount": "amount"
          }
        ],
        "totalInputAmount": "totalInputAmount",
        "totalOutputAmount": "totalOutputAmount"
      }
    }
  ]
}

json

application/json

Address

[ { "id": "id", "type": "bitcoin_deposit", "status": "confirmed", "amountSats": 0, "tokenAmount": "string", "tokenMetadata": { "tokenIdentifier": "tokenIdentifier", "tokenAddress": "tokenAddress", "name": "name", "ticker": "ticker", "decimals": 0, "issuerPublicKey": "issuerPublicKey", "maxSupply": "string", "isFreezable": true }, "multiIoDetails": { "inputs": [ { "address": "address", "pubkey": "pubkey", "amount": "amount" } ], "outputs": [ { "address": "address", "pubkey": "pubkey", "amount": "amount" } ], "totalInputAmount": "totalInputAmount", "totalOutputAmount": "totalOutputAmount" }, "from": { "type": "spark", "identifier": "identifier", "pubkey": "string" }, "to": { "type": "spark", "identifier": "identifier", "pubkey": "string" }, "bitcoinTxid": "string", "valueUsd": 0, "createdAt": "2024-08-25T15:00:00Z", "updatedAt": "2024-08-25T15:00:00Z" } ]

Variant

Matching Criteria

type = object · requires: id, type, status +2 more

{ "id": "id", "type": "type", "status": "confirmed", "createdAt": "2024-08-25T15:00:00Z", "updatedAt": "2024-08-25T15:00:00Z", "from": { "type": "spark", "identifier": "identifier", "pubkey": "string" }, "to": { "type": "spark", "identifier": "identifier", "pubkey": "string" }, "amountSats": 0, "valueUsd": 0, "timeTakenSeconds": 0, "txid": "string", "bitcoinTxData": { "txid": "txid", "vin": [ { "prevout": {}, "witness": [ "string" ], "value": 0 } ], "vout": [ { "scriptpubkey_address": "string", "value": 0 } ], "status": { "confirmed": true, "block_height": 0, "block_time": 0 }, "fee": 0 } }

{ "meta": { "totalItems": 0, "limit": 0, "offset": 0 }, "data": [ { "id": "id", "type": "spark_transfer", "direction": "incoming", "counterparty": { "type": "spark", "identifier": "identifier", "tokenMetadata": { "tokenIdentifier": "tokenIdentifier", "tokenAddress": "tokenAddress", "name": "name", "ticker": "ticker", "decimals": 0, "issuerPublicKey": "issuerPublicKey", "maxSupply": "string", "isFreezable": true } }, "amountSats": 0, "tokenAmount": "string", "valueUsd": 0, "createdAt": "2024-08-25T15:00:00Z", "updatedAt": "2024-08-25T15:00:00Z", "status": "confirmed", "txid": "string", "tokenMetadata": { "tokenIdentifier": "tokenIdentifier", "tokenAddress": "tokenAddress", "name": "name", "ticker": "ticker", "decimals": 0, "issuerPublicKey": "issuerPublicKey", "maxSupply": "string", "isFreezable": true }, "multiIoDetails": { "inputs": [ { "address": "address", "pubkey": "pubkey", "amount": "amount" } ], "outputs": [ { "address": "address", "pubkey": "pubkey", "amount": "amount" } ], "totalInputAmount": "totalInputAmount", "totalOutputAmount": "totalOutputAmount" } } ] }

{ "meta": { "totalItems": 0, "limit": 0, "offset": 0 }, "data": [ { "id": "id", "type": "type", "status": "confirmed", "createdAt": "2024-08-25T15:00:00Z", "updatedAt": "2024-08-25T15:00:00Z", "from": { "type": "spark", "identifier": "identifier", "pubkey": "string" }, "to": { "type": "spark", "identifier": "identifier", "pubkey": "string" }, "amount": "amount", "valueUsd": 0, "tokenMetadata": { "tokenIdentifier": "tokenIdentifier", "tokenAddress": "tokenAddress", "name": "name", "ticker": "ticker", "decimals": 0, "issuerPublicKey": "issuerPublicKey", "maxSupply": "string", "isFreezable": true }, "multiIoDetails": { "inputs": [ { "address": "address", "pubkey": "pubkey", "amount": "amount" } ], "outputs": [ { "address": "address", "pubkey": "pubkey", "amount": "amount" } ], "totalInputAmount": "totalInputAmount", "totalOutputAmount": "totalOutputAmount" } } ] }