Skip to main content

GET collections

/v1/collections​

Get a list sorted and filtered according to your need with the information of the collections that are registered in the Apexgo database.

Limit

/v1/collections?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, 0 will be adopted.

Offset

/v1/collections?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, 0 will be adopted.

Filters

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

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

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

1. Collection acronym​

/v1/collections?acronym=tbc

Collections have abbreviations that facilitate their identification. You can filter collections by acronyms.

2. Blockchain​

/v1/collections?blockchain=Ethereum

You can also search for specific blockchain collections.

Possible values:

  • ethereum
  • tron
  • polygon

Note: values are case insensitive

3. Status​

/v1/collections?status=Featured

Filter the collections to be returned by their popularity.

Possible values:

  1. Featured
  2. Hot
  3. Upcoming

Note: values are case insensitive

4. Creator address​

/v1/collections?creator_address={wallet_address}

Filter the collections to be returned by their owner's wallet address.

5. Calculated​

/v1/collections?is_calculated={value}

Possible values:

  • true
  • false

Returns collections given their calculation status.

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/collections?order_by={ordering}

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

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/collections?order_by=acronym&order_direction={order}

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

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 asc , if you don't specify a value, this value will be adopted.

Note: Values are case-insensitive

Image edition

You can select the size of the images present in the returns. With this, you can have lighter images to speed up loading on the frontend when we are talking about a large volume of returns.

/v1/collections?banner_size={size100}&icon_size={size120}

banner_size: determines the size of the collection banner image

icon_size: determines the size of the collection icon image

Possible values:

  • size(number)
  • width(number)
  • height(number)
  • crop
  • crop_center
Expected return

An array of collections.

{
  "response": [
    {
      "collection_id": 99,
      "name": "tron-bull-club",
      "display_name": "Tron Bull Club",
      "acronym": "TBC",
      "description": "15012 Unique Tron Bulls",
      "icon": "https://lh3.googleusercontent.com/0q6lr2T0W4CpLuXVvWj08MNlgi0P82ojiY1ay4H7qe0-h4rPEi-ROPuIDVQr7Ft1dFRmd56TJqSVT7lBDNYw7lc-73c__FzB7txt_W3GvMynYCox2JM",
      "banner": "https://lh3.googleusercontent.com/OIEvMI5chgF1ym3jxBjrtI6zM-LeR1TavVeM-wSnfwFdXSWK8FIqVDH88qs7lUy5XFtf8U9onnswFRf-HhRsRvuUMBw5Py-hj4GuKn41jXrBB96DTsc=s2500",
      "blockchain": "Tron",
      "contract_address": "Tron",
      "creator_address": "Tron",
      "status": "Tron",
      "links": {
        "website": "https://tronbullclub.com",
        "twitter": "https://twitter.com/tronbullclub",
        "medium": null,
        "instagram": null,
        "group": null,
        "facebook": null,
        "wiki": null
      },
      "total_supply": 15012,
      "total_value": "1.0000001619000843e+27",
      "holders": 1179,
      "is_calculated": true,
      "adjustment_id": 421,
      "rarity_json": null,
      "requested_certificate": false,
      "is_certified": false
    }
  ],
  "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.