GET volume

/v1/volume

Get the volume of transactions that happened in a given collection.

Limiters

The limiters are for you to inform the desired size of the return of the list of volume collections.

1. Limit

/v1/volume?limit={maxNumber}

Get only the amount of collections you need by informing the amount through the query limit parameter.

Range/: 0 → 150

The default value of limit is 50, if you don't specify a value, this value will be adopted.

2. Offset

/v1/volume?offset={numToAvoid}

Offset ignores the desired amount of collections starting from 1 to offset. That is, if you want to skip the first 100 collections, the offset will be set to offset 100.

The default value of offset is 0, if you don't specify a value, this value will be adopted.

Interval

Specify a time interval and receive the total volume that that given collection had in the interval you entered, which can be in hours, days or months.

1. Hours

/v1/volume?interval_hours={number}

2. Days

/v1/volume?interval_days={number}

3. Months

/v1/volume?interval_months={number}

Order

You can control the order in which the response with the list of collections that suit your filters and following the limiters you choose will be returned.

1. Order by

/v1/volume?order_by={value}

The answer will be sorted based on some attribute of the collections.

Possible values are:

• id
• holders
• total_supply
• name
• display_name
• acronym
• total_value
• volume

Note: Values are case-insensitive

The default value of order_by is id, if you don't specify a value, this value will be adopted.

2. Order direction

/v1/volume?order_by=volume&order_direction={order}

Define the ordering direction of the response with the list of volume.

Possible values:

1. asc → represents an order that starts at the lowest value and ends at the highest reference value
2. desc → represents an order that starts at the highest value and ends at the lowest reference value

The default value of order_direction is ascending, if you don't specify a value, this value will be adopted.

Note: Values are case-insensitive

Filters

Filters help return volume that strictly comply with a rule passed by you. Filters follow the structure:

/v1/volume?{filter_name}={filter_value}

If a collection matches filter_name and filter_value, it will be returned.

1. Collection name

/v1/volume?collection_name={value}

Filter volume by collection name.

2. Blockchain

/v1/volume?blockchain={value}

You can also search for volume by specific blockchain.

Possible values:

• ethereum
• tron
• polygon

Note: values are case insensitive

3. Calculated

/v1/volume?is_calculated={value}

Filter the collections to be returned by their popularity.

Possible values:

1. true
2. false

Note: values are case insensitive

Expected return

An array of collections volume.

{
  "response": [
    {
      "collection_id": 99,
      "name": "tron-bull-club",
      "display_name": "Tron Bull Club",
      "acronym": "TBC",
      "icon": "https://lh3.googleusercontent.com/0q6lr2T0W4CpLuXVvWj08MNlgi0P82ojiY1ay4H7qe0-h4rPEi-ROPuIDVQr7Ft1dFRmd56TJqSVT7lBDNYw7lc-73c__FzB7txt_W3GvMynYCox2JM",
      "blockchain": "Tron",
      "volume": 267626.68,
      "total_supply": 15012,
      "total_value": "1.0000001619000843e+27",
      "holders": 1179,
      "is_calculated": true,
      "adjustment_id": 421
    }
  ],
  "paging": {
    "total": 1,
    "pages": 1,
    "page": 1
  }
}

Errors

400 Invalid Request

Your request is malformed. Please, check the documentation out.

401 API key is invalid

You did not pass the API key for getting authorization.

404 Data not found

Your request returned with no matches.

429 Too many requests

You are hiting the API request limit.

500 Internal server error

The server did not know how to handle this error.