Sparkscan API

Address

Endpointhttps://api.sparkscan.io

Download schema

Operations related to addresses

GET

https://api.sparkscan.io

/v1/address/{address}

path Parameters

address

string · required

query Parameters

network

string · enum

Enum values:

MAINNET

REGTEST

Responses

Response for status 200

sparkAddress

string · required

publicKey

string · required

object · required

totalValueUsd

number · required

transactionCount

integer · required

tokenCount

integer · required

GET/v1/address/{address}

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

shell

Example Responses

{
  "sparkAddress": "sparkAddress",
  "publicKey": "publicKey",
  "balance": {
    "btcSoftBalanceSats": 0,
    "btcHardBalanceSats": 0,
    "btcValueUsdHard": 0,
    "btcValueUsdSoft": 0,
    "totalTokenValueUsd": 0
  },
  "totalValueUsd": 0,
  "transactionCount": 0,
  "tokenCount": 0,
  "tokens": [
    {
      "tokenIdentifier": "tokenIdentifier",
      "tokenAddress": "tokenAddress",
      "name": "name",
      "ticker": "ticker",
      "decimals": 0,
      "balance": "balance",
      "valueUsd": 0,
      "issuerPublicKey": "issuerPublicKey",
      "maxSupply": "string",
      "isFreezable": true
    }
  ]
}

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/address/{address}/tokens

path Parameters

address

string · required

query Parameters

network

string · enum

Enum values:

MAINNET

REGTEST

Responses

Response for status 200

object[] · required

required

totalTokenValueUsd

number · required

GET/v1/address/{address}/tokens

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

shell

Example Responses

{
  "tokens": [
    {
      "tokenIdentifier": "tokenIdentifier",
      "tokenAddress": "tokenAddress",
      "name": "name",
      "ticker": "ticker",
      "decimals": "string",
      "balance": "balance",
      "valueUsd": 0,
      "issuerPublicKey": "issuerPublicKey",
      "iconUrl": "iconUrl",
      "maxSupply": "string",
      "isFreezable": true
    }
  ],
  "tokenCount": "string",
  "totalTokenValueUsd": 0
}

json

application/json

Tx Token

{ "sparkAddress": "sparkAddress", "publicKey": "publicKey", "balance": { "btcSoftBalanceSats": 0, "btcHardBalanceSats": 0, "btcValueUsdHard": 0, "btcValueUsdSoft": 0, "totalTokenValueUsd": 0 }, "totalValueUsd": 0, "transactionCount": 0, "tokenCount": 0, "tokens": [ { "tokenIdentifier": "tokenIdentifier", "tokenAddress": "tokenAddress", "name": "name", "ticker": "ticker", "decimals": 0, "balance": "balance", "valueUsd": 0, "issuerPublicKey": "issuerPublicKey", "maxSupply": "string", "isFreezable": true } ] }

{ "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" } } ] }