API Reference

Retrieve the token balance history of a wallet for a given ERC20 token.

Method: GET

Endpoint: https://api.syve.ai/v1/wallet-api/historical/token-balance

🚧

Coming Soon

This endpoint is currently not live.

Request Parameters

NameType(s)Description
wallet_addressstringThe wallet address to fetch token balances for.

This is a required parameter.
token_addressintegerThe address of the ERC20 token to return historical balance for.

This is a required parameter.
intervalstringThis parameter determines the time interval for each bucket data.

The format should be <value><freq>, where freq can be "s" (seconds), "m" (minutes), "h" (hours), or "d" (days).

For example, "10s" would represent a 10-second interval, and "1d" would represent a 1-day interval. The default value is "1d" (1 day).
sizeintegerThe size parameter controls how many records to return in the response. Default is 10. Maximum is 1,000.
from_timestampintegerReturn results whose timestamp are greater than or equal to the provided value. The default value is 10 periods before until_timestamp, where the period depends on the interval chosen.
until_timestampintegerReturn results whose timestamp are less than or equal to the provided value. The default value is the current timestamp (at the time the request is made).

Response Fields

Response FieldTypeDescription
from_timestampintegerThis field indicates the timestamp at the beginning of the interval (inclusive) for the returned OHLC data.

It's in Unix timestamp format (seconds since the Unix Epoch, 1970-01-01 00:00:00 UTC).
until_timestampintegerThis field indicates the timestamp at the end of the interval (inclusive) for the returned OHLC data in Unix timestamp format.
from_datestringThis field represents the date and time at the beginning of the interval for the returned OHLC data, in ISO 8601 format (yyyy-mm-ddThh:mm:ssZ).
until_datestringThis field represents the date and time at the end of the interval for the returned OHLC data, in ISO 8601 format.
balance_token_closedoubleThe closing token balance for the given interval and wallet address.
balance_base_closeintegerThe closing token balance (in base format) for the given interval and wallet address.

Live Example

Press Try It to make a request and see what the response looks like. Feel free to try different query parameters.

Language
Click Try It! to start a request and see the response here!