📘API Docs

This page details how to interact with the Sunblocks API

Before getting started you must register an account to create an API Key. You will not be able to access the services without a valid API key.

Overview

To query an address, send a GET request to

https://www.sunblocks.xyz/api/<CHAIN>?address=<publicKey>

We currently support BTC, ETH, and SOL blockchains. You must include the X-API-Key field along with your api key in the header.

Endpoints

BTC - https://www.sunblocks.xyz/api/btc?address=<publicKey>

ETH - https://www.sunblocks.xyz/api/eth?address=<publicKey>

SOL - https://www.sunblocks.xyz/api/sol?address=<publicKey>

USDT - https://www.sunblocks.xyz/api/usdt?address=<publicKey>

Response

If the address submitted matches an address on our blacklist, the response will contain the address submitted, a Boolean value set to true indicating the address is on a list, the name of the list it was matched on, and a confidence score indicating how likely it is this address should be blacklisted (confidence score is currently a work in progress).

{"address":"1BcWuWf4YZTbKb4s3jieWr7qYJPeg3aika", "confidence":100, "listName":"RANSOM", "onList":true}

If the address submitted DOES NOT match an address on our blacklist, the response will contain the address submitted, a Boolean value set to false indicating the address is NOT on a list, and a confidence score set to 0, indicating this address should not be blacklisted.

{"address":"0xD5d6f8D9e784d0e26222ad38300801a68D027D", "confidence":0, "listName":null, "onList":false}

Examples

Check if a bitcoin address is blacklisted

curl -H "X-API-Key: your-secret-api-key" https://sunblocks.xyz/api/btc?address=1BcWuWf4YZTbKb4s3jieWr7qYJPeg3aika