Address

Get Address Info

This endpoint retrieves various information for a given address.

HTTP Request
GET https://api.whatsonchain.com/v1/bsv/<network>/address/<address>/info
cURL
curl --location --request GET "https://api.whatsonchain.com/v1/bsv/main/address/16ZqP5Tb22KJuvSAbjNkoiZs13mmRmexZA/info"
Response JSON structure
{
    "address": "16ZqP5Tb22KJuvSAbjNkoiZs13mmRmexZA",
    "ismine": false,
    "isscript": false,
    "isvalid": true,
    "iswatchonly": false,
    "scriptPubKey": "76a9143d0e5368bdadddca108a0fe44739919274c726c788ac"
}

URL Parameters

ParameterDescription

network

The selected network: main or test.

address

The address

Get Address Usage Status

This endpoint serves as a usage status flag for a given address.

HTTP Request
GET https://api.whatsonchain.com/v1/bsv/<network>/address/<address>/used
cURL
curl --location --request GET "https://api.whatsonchain.com/v1/bsv/main/address/174XactYXkNJkPYBpsPAuzHkwG5snmLNpC/used"
Response JSON structure
true

URL Parameters

ParameterDescription

network

The selected network: main or test.

address

The address

Get Associated Scripthashes

There are some addresses that are associated with multiple script types. This endpoint returns a list of scripthashes associated to the given address, and their types.

HTTP Request
GET https://api.whatsonchain.com/v1/bsv/<network>/address/<address>/scripts
cURL
curl --location --request GET "https://api.whatsonchain.com/v1/bsv/main/address/12c6DSiU4Rq3P4ZxziKxzrL5LmMBrzjrJX/scripts"
Response JSON structure
[
    {
        "script": "55f4cd3dabddd62707b374f69f66b97f5f53dac5b204bd6c09dcad39b54862d1",
        "type": "pubkeyhash"
    },
    {
        "script": "cc0d7111befe9f24f1824c797e837c5cff2f8773901ccb9aca0372a2a6c48d34",
        "type": "pubkey"
    }
]

URL Parameters

ParameterDescription

network

The selected network: main or test.

address

The address

Download Statement

You can download the statement (in PDF) for a given address.

HTTP Request
GET https://<network>.whatsonchain.com/statement/<address>
cURL
curl --location --request GET  "https://main.whatsonchain.com/statement/16ZqP5Tb22KJuvSAbjNkoiZs13mmRmexZA"

URL Parameters

ParameterDescription

network

The selected network: main or test.

address

The address

Get Unconfirmed Balance (Beta)

This endpoint retrieves the unconfirmed balance for a given address.

HTTP Request
GET https://api.whatsonchain.com/v1/bsv/<network>/address/<address>/unconfirmed/balance
cURL
curl --location --request GET "https://api.whatsonchain.com/v1/bsv/main/address/1Dbj1LUxTqtuZ1U52KZiZChLPHkTAMiD6h/unconfirmed/balance"
Response JSON structure
{
    "unconfirmed": 103
}

URL Parameters

ParameterDescription

network

The selected network: main or test.

address

The address

Bulk Unconfirmed Balance (Beta)

This endpoint retrieves the unconfirmed balance for multiple addresses in a single request.

  • Max 20 addresses per request.

HTTP Request
POST https://api.whatsonchain.com/v1/bsv/<network>/addresses/unconfirmed/balance
cURL
curl --location --request POST "https://api.whatsonchain.com/v1/bsv/main/addresses/unconfirmed/balance" \
  --header "Content-Type: application/json" \
  --data "{\"addresses\" : [\"16ZBEb7pp6mx5EAGrdeKivztd5eRJFuvYP\" ] }"
Request body JSON structure
{
    "addresses":
    [
        "16ZBEb7pp6mx5EAGrdeKivztd5eRJFuvYP"
    ]
}
Response JSON structure
[
    {
        "address": "16ZBEb7pp6mx5EAGrdeKivztd5eRJFuvYP",
        "unconfirmed": 0,
        "error": ""
    }
]

URL Parameters

ParameterDescription

network

The selected network: main, test, or stn.

Get Confirmed Balance (Beta)

This endpoint retrieves the confirmed balance for a given address.

HTTP Request
GET https://api.whatsonchain.com/v1/bsv/<network>/address/<address>/confirmed/balance
cURL
curl --location --request GET "https://api.whatsonchain.com/v1/bsv/main/address/1Dbj1LUxTqtuZ1U52KZiZChLPHkTAMiD6h/confirmed/balance"
Response JSON structure
{
    "confirmed": 181827
}

URL Parameters

ParameterDescription

network

The selected network: main or test.

address

The address

Bulk Confirmed Balance (Beta)

This endpoint retrieves the confirmed balance for multiple addresses in a single request.

  • Max 20 addresses per request.

HTTP Request
POST https://api.whatsonchain.com/v1/bsv/<network>/addresses/confirmed/balance
cURL
curl --location --request POST "https://api.whatsonchain.com/v1/bsv/main/addresses/confirmed/balance" \
  --header "Content-Type: application/json" \
  --data "{\"addresses\" : [\"1KGHhLTQaPr4LErrvbAuGE62yPpDoRwrob\",\"1ApLMk225o7S9FvKwpNChB7CX8cknQT9Hy\" ] }"
Request body JSON structure
{
    "addresses":
    [
        "1KGHhLTQaPr4LErrvbAuGE62yPpDoRwrob",
        "1ApLMk225o7S9FvKwpNChB7CX8cknQT9Hy"
    ]
}
Response JSON structure
[
    {
        "address": "1KGHhLTQaPr4LErrvbAuGE62yPpDoRwrob",
        "script": "4f8f588fc9bd7304dc73a14c5d3d0813e048986465e22587e3166ce04225a756",
        "confirmed": 0,
        "error": ""
    },
    {
        "address": "1ApLMk225o7S9FvKwpNChB7CX8cknQT9Hy",
        "script": "9b15c6471cb6f0314250e9ff180b4197a9c409c2791261ebe4e0c4b468ccaeb8",
        "confirmed": 688992295481,
        "error": ""
    }
]

URL Parameters

ParameterDescription

network

The selected network: main, test, or stn.

(Planned for deprecation) Get Balance

This endpoint is powered by ElectrumX and is planned for deprecation in the near future.

This endpoint retrieves both the confirmed and unconfirmed balance for a given address.

HTTP Request
GET https://api.whatsonchain.com/v1/bsv/<network>/address/<address>/balance
cURL
curl --location --request GET "https://api.whatsonchain.com/v1/bsv/main/address/1GJ3x5bcEnKMnzNFPPELDfXUCwKEaLHM5H/balance"
Response JSON structure
{
    "confirmed":533134093647,
    "unconfirmed":0
}

URL Parameters

ParameterDescription

network

The selected network: main or test.

address

The address

(Planned for deprecation) Bulk Balance

This endpoint is powered by ElectrumX and is planned for deprecation in the near future.

This endpoint retrieves both the confirmed and unconfirmed balance for multiple addresses in a single request.

  • Max 20 addresses per request.

HTTP Request
POST https://api.whatsonchain.com/v1/bsv/<network>/addresses/balance
cURL
curl --location --request POST "https://api.whatsonchain.com/v1/bsv/main/addresses/balance" \
  --header "Content-Type: application/json" \
  --data "{\"addresses\" : [\"16ZBEb7pp6mx5EAGrdeKivztd5eRJFuvYP\",\"1KGHhLTQaPr4LErrvbAuGE62yPpDoRwrob\" ] }"

The JSON structure for the above post request:

JSON structure
{
    "addresses":
    [
        "16ZBEb7pp6mx5EAGrdeKivztd5eRJFuvYP",
        "1KGHhLTQaPr4LErrvbAuGE62yPpDoRwrob"
    ]
}
Response JSON structure
[
    {
        "address": "16ZBEb7pp6mx5EAGrdeKivztd5eRJFuvYP",
        "balance": {
            "confirmed": 450000,
            "unconfirmed": 0
        },
        "error": ""
    },
    {
        "address": "1KGHhLTQaPr4LErrvbAuGE62yPpDoRwrob",
        "balance": {
            "confirmed": 0,
            "unconfirmed": 0
        },
        "error": ""
    }
]

URL Parameters

ParameterDescription

network

The selected network: main, test, or stn.

Get Unconfirmed History (Beta)

This endpoint retrieves unconfirmed transactions for a given address. Returns up to 100k results in one request.

HTTP Request
GET https://api.whatsonchain.com/v1/bsv/<network>/address/<address>/unconfirmed/history
cURL
curl --location --request GET "https://api.whatsonchain.com/v1/bsv/main/address/1Dbj1LUxTqtuZ1U52KZiZChLPHkTAMiD6h/unconfirmed/history"
Response JSON structure
{
    "result": [
        {
            "tx_hash": "93d8ae93a9e074c555d80e86c130b6cd4d5c7efa2795f91b2aea285c546512c6"
        },
        {
            "tx_hash": "6bcd7708adf5c8c00d299628ef86fa5d982ccd1909254f46ea0f0a70c4c319f7"
        },
        {
            "tx_hash": "cf1f1fd7962aeac56932b0e522d83c163d89873f2e26a1519bcc0d88772d0e78"
        },
        ...
    ]
}    

URL Parameters

ParameterDescription

network

The selected network: main or test.

address

The address

Bulk Unconfirmed History (Beta)

This endpoint retrieves the history of unconfirmed transactions for a given set of addresses.

  • Max 20 addresses per request.

  • Max 100 items returned per request.

HTTP Request
POST https://api.whatsonchain.com/v1/bsv/<network>/addresses/unconfirmed/history
cURL
curl --location --request POST "https://api.whatsonchain.com/v1/bsv/main/addresses/unconfirmed/history" \
  --header "Content-Type: application/json" \
  --data "{\"addresses\" : [ \"16ZBEb7pp6mx5EAGrdeKivztd5eRJFuvYP\" ] }"
Request body JSON structure
{
    "addresses": [
        "16ZBEb7pp6mx5EAGrdeKivztd5eRJFuvYP"
    ]
}
Response JSON structure
[
    {
        "address": "16ZBEb7pp6mx5EAGrdeKivztd5eRJFuvYP",
        "script": "c7713679ea48e31aec663612f5cbaeb86f9241677c0397b42d957545b47ca2fe",
        "result": [
            {
                "tx_hash": "6216506e2b5ef029595e1b29a20c279889873a9da4e98bcb5c619a4756ab6932",
                "height": 658093
            },
            {
                "tx_hash": "df860638d1530d2ba1f25d167fa24bbef3b1387e94207ee5e11fa535413aff39",
                "height": 658093
            }
        ],
        "error": ""
    }
]

URL Parameters

ParameterDescription

network

The selected network: main or test.

Get Confirmed History (Beta)

This endpoint retrieves confirmed transactions for a given address. Pagination is available using the provided next-page token.

HTTP Request
GET https://api.whatsonchain.com/v1/bsv/<network>/address/<address>/confirmed/history
cURL
curl --location --request GET "https://api.whatsonchain.com/v1/bsv/main/address/1Dbj1LUxTqtuZ1U52KZiZChLPHkTAMiD6h/confirmed/history"
Response JSON structure
{
    "result": [
        {
            "tx_hash": "6cc9631ef3dad77eb0141134167f20469d0b4e61405de57fe6a9ac71b943bb9f",
            "height": 797518
        }
    ]
} 

URL Parameters

ParameterDescription

network

The selected network: main or test.

address

The address

order

Ordering: asc or desc; default is desc.

limit

Between 1 and 1000; default is 100.

height

Starting block height for history; default is 0.

token

Provided next page token.

Bulk Confirmed History (Beta)

This endpoint retrieves the history of confirmed transactions for a given set of addresses.

  • Max 20 addresses per request.

  • Max 20 items returned per request.

For pagination please use the single address endpoint.

HTTP Request
POST https://api.whatsonchain.com/v1/bsv/<network>/addresses/confirmed/history
cURL
curl --location --request POST "https://api.whatsonchain.com/v1/bsv/main/addresses/confirmed/history" \
  --header "Content-Type: application/json" \
  --data "{\"addresses\" : [ \"16ZBEb7pp6mx5EAGrdeKivztd5eRJFuvYP\" ] }"
Request body JSON structure
{
    "addresses": [
        "16ZBEb7pp6mx5EAGrdeKivztd5eRJFuvYP"
    ]
}
Response JSON structure
[
    {
        "address": "16ZBEb7pp6mx5EAGrdeKivztd5eRJFuvYP",
        "script": "c7713679ea48e31aec663612f5cbaeb86f9241677c0397b42d957545b47ca2fe",
        "result": [
            {
                "tx_hash": "6216506e2b5ef029595e1b29a20c279889873a9da4e98bcb5c619a4756ab6932",
                "height": 658093
            },
            {
                "tx_hash": "df860638d1530d2ba1f25d167fa24bbef3b1387e94207ee5e11fa535413aff39",
                "height": 658093
            }
        ],
        "error": ""
    }
]

URL Parameters

ParameterDescription

network

The selected network: main or test.

Bulk History (Beta)

This endpoint retrieves the history of both confirmed and unconfirmed transactions for a given set of addresses.

  • Max 20 addresses per request.

  • Max 1000 confirmed and max 1000 unconfirmed history items returned per request.

  • Page tokens provided if address contains more items than above.

  • Call standard individual unconfirmed and confirmed endpoints with page token for more history if required.

HTTP Request
POST https://api.whatsonchain.com/v1/bsv/<network>/addresses/history/all
cURL
curl --location --request POST "https://api.whatsonchain.com/v1/bsv/main/addresses/history/all" \
  --header "Content-Type: application/json" \
  --data "{\"addresses\" : [ \"16ZBEb7pp6mx5EAGrdeKivztd5eRJFuvYP\", \"19SsDUJ29XM2VDCkZKnTXJ9Zjt3gMtnrwC\" ] }"
Request body JSON structure
{
    "addresses": [
        "16ZBEb7pp6mx5EAGrdeKivztd5eRJFuvYP",
        "19SsDUJ29XM2VDCkZKnTXJ9Zjt3gMtnrwC"
    ]
}
Response JSON structure
[
    {
        "address":"16ZBEb7pp6mx5EAGrdeKivztd5eRJFuvYP",
        "script":"c7713679ea48e31aec663612f5cbaeb86f9241677c0397b42d957545b47ca2fe",
        "unconfirmed":
            {
                "result":[],
                "error":""
            },
        "confirmed":
            {
                "result":[
                    {
                        "tx_hash":"6216506e2b5ef029595e1b29a20c279889873a9da4e98bcb5c619a4756ab6932",
                        "height":658093
                    },
                    {
                        "tx_hash":"df860638d1530d2ba1f25d167fa24bbef3b1387e94207ee5e11fa535413aff39",
                        "height":658093
                    }
                ],
                "error":""
            }
    },
    {
        "address":"19SsDUJ29XM2VDCkZKnTXJ9Zjt3gMtnrwC",
        "script":"9ad0daaac33264199ce40596970c5ccf0096eb05b9b020002a3f1c2202841ef9",
        "unconfirmed":
            {
                "result":[],
                "error":""
            },
        "confirmed":
            {
                "result":
                    [
                        {
                            "tx_hash":"06f978c8758b45aa298e74d2951123811da06d9b22ad433fcaeceb90fb3db6cd",
                            "height":825487
                        },
                        {
                            "tx_hash":"064cad8a9ff3caad45579ee514d6a352f402ab02ed355bc9d4f9fce3eac07813",
                            "height":825488
                        }
                    ],
                "error":""
            }
    }
]

URL Parameters

ParameterDescription

network

The selected network: main or test.

(Planned for deprecation) Get History

This endpoint is powered by ElectrumX and is planned for deprecation in the near future.

This endpoint retrieves both confirmed and unconfirmed transactions for a given address.

HTTP Request
GET https://api.whatsonchain.com/v1/bsv/<network>/address/<address>/history
cURL
curl --location --request GET "https://api.whatsonchain.com/v1/bsv/main/address/1GJ3x5bcEnKMnzNFPPELDfXUCwKEaLHM5H/history"

Returns a response as long as the response message is less than 1MB in size.

Response JSON structure
[
    {
        "tx_hash": "2b5ccedd76ba0d524d95ecce1c8a76e5888e0f13591734be0169ba0220c69208",
        "height": 573216
    },
    {
        "tx_hash": "7fe815e14b32aaaecc2cca7ed605ed612b532765710917cb711ea71cf55e36b5",
        "height": 573229
    },
    {
        "tx_hash": "b28dd1723d0d1fa6e4b2875f7419028c1c1441fc02469aebc444c0a42d0bac3f",
        "height": 573230
    },
    ...
]    

URL Parameters

ParameterDescription

network

The selected network: main or test.

address

The address

Last updated