NAV Navbar
shell java python php node.js javascript

Introduction

Coinscious Data Service - BlockChain Data API: Our comprehensive raw blockchain data API services include blockchain transaction data, top transactions, balance of the important accounts, transactions with highlighted addresses. Feel free to download our Blockchain API specification.

Version: 1.0.0

Requests

Exchange

Please refer to the value of name field in the response returned by Exchange List Exchange List API.

Token

Please refer to the response returned by Token List API. Only lower case is accepted.

Interval, Limit and Date Range

We support the following intervals: 1h, 6h, 12h, 1d. The default interval is 30m if it is not specified.

"Limit" is the number of data returned in JSON response.
* Limit is set to the default value of 500 if it is not specified.
* We only accept limits less than and equal to 2000. Multiple calls are required with different time ranges to pull more data.

You can also specify your query date range by defining the start and end in query parameters.
* "End" is set to the current timestamp by default.
* "Start" is calculated based on end, limit, and interval.

Response

Coinscious uses standard HTTP response codes to indicate the success or failure of an API request. For example,
* Code 200 indicates success.
* Code 400 indicates an error that resulted from the provided information (e.g., a required parameter was missing).

JSON structure of an unexpected error response is the following:

{
  "code": "1001",
  "message": "Exchange not specified."
}

We support the following list of standard HTTP response codes:

Status Code Description
200 It's All Good.
400 Unexpected Error
Refer to the list of Error Codes we provide.
401 Unauthorized
403 Forbidden
404 Not Found
405 Method Not Allowed
429 Too Many Requests
500 Internal Server Error

BlockChain API

Exchange Wallet Balance

Obtain the wallet balance of a specific token found on a supported exchange.

HTTP Request

GET /balance/{exchange}/{token}

Parameters

Name Required Type Description
exchange Yes string Exchanges supported
token Yes string Token supported
interval No string Interval and limit
start No timestamp
end No timestamp
limit No integer Interval and limit

The request returns JSON structured like the following:

[
  {
    "timestamp": 1515100800000,
    "amount": 23178.43232
  },
  {
    "timestamp": 1515101100000,
    "amount": 56782.93234203
  }
]

Responses

Code Description
200 Successful response

Token Team Balance

Obtain the balance owned by a token team.

HTTP Request

GET /balance/team/{token}

Parameters

Name Required Type Description
token Yes string Token supported
interval No string Interval and limit
start No timestamp
end No timestamp
limit No integer Interval and limit

The request returns JSON structured like the following:

[
  {
    "timestamp": 1515100800000,
    "balances": [
      {
        "token": "ETH",
        "amount": 21394.43281793
      },
      {
        "token": "BTC",
        "amount": 3242.98565341
      }
    ]
  }
]

Responses

Code Description
200 Successful response

Outstanding Transactions

We consider the following transactions as the outstanding transaction: * A transaction amount that exceeds a pre-defined threshold value. * The outstanding transaction is ranked in the top percentile within a specific period.

HTTP Request

GET /transactions/top/{token}

Parameters

Name Required Type Description
token Yes string Token supported
start No timestamp
end No timestamp
limit No integer Interval and limit

The request returns JSON structured like the following:

[
  {
    "timestamp": 1515100800000,
    "transactionId": "5b9c4d62e93fb9b5bc1f1346",
    "amount": 45890.34212,
    "token": "btc",
    "senders":[
      {
        "address": "3JrCTAR83kKHd4vNodgU9TGhNmGr8ckwXd",
        "holder": "Binance"
      }
    ],
    "receivers":[
      {
        "address": "3HvxQLkpsEfYBuu5sKjhvQNZWNkTxGF97L",
        "holder": "EXX"
      },
      {
        "address": "0xaec98a708810414878c3bcdf46aad31d",
        "holder": "EXX"
      },
    ],
    "comment": "comments"
  }, 
  {
    "timestamp": 1515101100000,
    "transactionId": "5b7e153ce213a53a517a729b",
    "amount": 989767.374283742,
    "token": "btc",
    "senders":[
      {
        "address": "1BGtxvdQRVUcR82F4nCs4C4yGgqanZCuMa",
        "holder": "Binance"
      },
      {
        "address": "1MHxTqiukBzCVvdD7LWyYxt18W2tkZUx2u",
        "holder": "Binance"
      },
      {
        "address": "14iwwXn7j5BbCfj2brDqWao5KFZojKtN4r",
        "holder": "Binance"
      }
    ],
    "receivers":[
      {
        "address": "1PYkDTq1uvh3khFiVG82nKLStwoJdRYGGL",
        "holder": "EXX"
      },
      {
        "address": "1HDowE9SBH6rRpB8WdrEh74xqZx6uBFn2e",
        "holder": "EXX"
      },
    ],
    "comment": "comments"
  }
]

Responses

Code Description
200 Successful response

Blockchain Address Balance

Obtain the latest balance of a specific blockchain address.

HTTP Request

GET /addresses/{address}/{token}

Parameters

Name Required Type Description
address Yes string Blockchain address
token Yes string Token supported

The request returns JSON structured like the following:

{
  "balance": 124.344958
}

Responses

Code Description
200 Successful response

Blockchain Transactions by Address

Obtain all transactions by a specific blockchain address.

HTTP Request

GET /addresses/{address}/{token}/transactions

Parameters

Name Required Type Description
address Yes string Blockchain address
token Yes string Token suppoeted
size No integer Page size
10 transactions will be returned each page if size is not specified
page No integer Page no
The first page is by default returned when page is not specified.

The request returns JSON structured like the following:

[
  {
    "numberOfTransctions": 2,
    "totalPages": 1,
    "pageSize": 10,
    "pageNo": 0,
    "transactions": 
    [
      {
        "timestamp": 1515100800000,
        "transactionId": "5b9c4d62e93fb9b5bc1f1346",
        "amount": 45890.34212,
        "senders":[
          {
            "address": "3JrCTAR83kKHd4vNodgU9TGhNmGr8ckwXd",
            "holder": "Binance"
          }
        ],
        "receivers":[
          {
            "address": "3HvxQLkpsEfYBuu5sKjhvQNZWNkTxGF97L",
            "holder": "EXX"
          },
          {
            "address": "0xaec98a708810414878c3bcdf46aad31d",
            "holder": "EXX"
          },
        ],
        "comment": "comments"
      }, 
      {
        "timestamp": 1515101100000,
        "transactionId": "5b7e153ce213a53a517a729b",
        "amount": 989767.374283742,
        "token": "btc",
          "senders":[
          {
            "address": "1BGtxvdQRVUcR82F4nCs4C4yGgqanZCuMa",
            "holder": "Binance"
          },
          {
            "address": "1MHxTqiukBzCVvdD7LWyYxt18W2tkZUx2u",
            "holder": "Binance"
          },
          {
            "address": "14iwwXn7j5BbCfj2brDqWao5KFZojKtN4r",
            "holder": "Binance"
          }
        ],
        "receivers":[
          {
            "address": "1PYkDTq1uvh3khFiVG82nKLStwoJdRYGGL",
            "holder": "EXX"
          },
          {
            "address": "1HDowE9SBH6rRpB8WdrEh74xqZx6uBFn2e",
            "holder": "EXX"
          },
        ],
        "comment": "comments"
      }
    ]
  }
]

Responses

Code Description
200 Successful response

Blockchain Transaction by ID

Obtain all blockchain transactions by a specific transaction ID.

HTTP Request

GET /transactions/{token}/{transactionId}

Parameters

Name Required Type Description
token Yes string Token supported
txId Yes string Transaction ID

The request returns JSON structured like the following:

{
  "timestamp": 1515100800000,
  "transactionId": "5b9c4d62e93fb9b5bc1f1346",
  "amount": 45890.34212,
  "token": "btc",
  "senders":[
    {
      "address": "3JrCTAR83kKHd4vNodgU9TGhNmGr8ckwXd",
      "holder": "Binance"
    }
  ],
  "receivers":[
    {
      "address": "3HvxQLkpsEfYBuu5sKjhvQNZWNkTxGF97L",
      "holder": "EXX"
    },
    {
      "address": "0xaec98a708810414878c3bcdf46aad31d",
      "holder": "EXX"
    },
  ],
  "comment": "comments"
}

Responses

Code Description
200 Successful response

Error Codes

Coinscious Data Services - BlockChain Data API uses the following error codes:

Error Code Meaning
1001 Exchange not specified.
1002 Exchange not supported.
1005 Token not specified.
1006 Token not supported.
1008 Interval not supported.
1009 Limit exceeds max limit supported.
1010 Invalid data range.
1011 Date range less than interval.
2001 Address not specified.
2002 Invalid address or address not found.
2003 Transaction ID not specified.
2004 Invalid transaction ID or transaction ID not found.