> For the complete documentation index, see [llms.txt](https://docs.certhis.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.certhis.io/api-endpoints/collection.md).

# COLLECTION

## GET Single Collection

#### Example of request:

<pre><code><strong>https://api.certhis.io/collection
</strong></code></pre>

{% tabs %}
{% tab title="REQUEST" %}
Query Parameters<br>

<table><thead><tr><th width="319">Parameter</th><th>Description</th></tr></thead><tbody><tr><td>collection_id</td><td>the <code>int</code> representing the ID of the Collection on the certhis smart contract</td></tr><tr><td>contract_id</td><td>the <code>id</code> representing the contract adress of the collection</td></tr></tbody></table>

\
\
Another query parameters group

|                     |                                                                                |
| ------------------- | ------------------------------------------------------------------------------ |
| collection\_address | the `string` representing the contract adress of the collection                |
| chain\_id           | the `int` representing the ID of network of the collection deployed on certhis |

\
\
Another query parameter that can work with only 1 parameter

| Parameter         | Description                                     |
| ----------------- | ----------------------------------------------- |
| collection\_index | the `int` representing the ID of the Collection |
| {% endtab %}      |                                                 |

{% tab title="RESPONSE" %}
Sample response

```
{
   "status":true,
   "message":"get_collection",
   "data":{
      "id":600,
      "collection_logo":null,
      "collection_header":null,
      "collection_name":"off white black",
      "collection_symbole":"OFFW",
      "collection_description":"",
      "collection_tagline":"",
      "collection_instagram":"",
      "collection_twitter":"",
      "collection_discord":"",
      "root_price":"0xfbb836600bce7207952f5cc377436d99941ac2d4b8d068ed0999bc449c4864bc",
      "collection_id":75,
      "label_id":61,
      "label_index":532,
      "collection_address":"0x3b8f50382D5CdCbBAd2Bd7725817b5e6B5E438ea",
      "creator_address":"0xbCD28f4d25b4E86abFB2b02b696a7B81faB07469",
      "collection_type":false,
      "collection_tax":"0",
      "collection_payout":"0xbCD28f4d25b4E86abFB2b02b696a7B81faB07469",
      "mintable_activate":"0",
      "price_for_mint":"0",
      "collection_payout_mint":"0xbCD28f4d25b4E86abFB2b02b696a7B81faB07469",
      "created":"2022-11-29T09:18:05.000Z",
      "currency_for_mint":"0x0000000000000000000000000000000000000000",
      "tax_descativate":"0x0000000000000000000000000000000000000000",
      "collection_full":"2",
      "mint_start":"0",
      "mint_end":"0",
      "sell_id":"0",
      "collection_uri":"https://certhis.mypinata.cloud/ipfs/QmSRE5iGJCnNMti5t6RukoUxPccX3ouDRwKx7Sy5jupcNR",
      "max_mint":"0",
      "max_mint_sell":"0",
      "max_supply":29,
      "root":"0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
      "currency_object":{
         "name":"AVALANCHE",
         "decimals":18,
         "symbol":"AVAX",
         "logoURI":""
      },
      "currency_object_tax_descativate":{
         "name":"AVALANCHE",
         "decimals":18,
         "symbol":"AVAX",
         "logoURI":""
      },
      "contract_id":51,
      "whitelist":"[]",
      "affiliation":"0",
      "collection_price":"[\"0:0x0000000000000000000000000000000000000000:10000000000000000\",\"1:0x0000000000000000000000000000000000000000:20000000000000000\",\"2:0x0000000000000000000000000000000000000000:10000000000000000\",\"3:0x0000000000000000000000000000000000000000:30000000000000000\",\"4:0x0000000000000000000000000000000000000000:10000000000000000\",\"5:0x0000000000000000000000000000000000000000:10000000000000000\",\"6:0x0000000000000000000000000000000000000000:10000000000000000\",\"7:0x0000000000000000000000000000000000000000:10000000000000000\",\"8:0x0000000000000000000000000000000000000000:30000000000000000\",\"9:0x0000000000000000000000000000000000000000:30000000000000000\",\"10:0x0000000000000000000000000000000000000000:30000000000000000\",\"11:0x0000000000000000000000000000000000000000:20000000000000000\",\"12:0x0000000000000000000000000000000000000000:20000000000000000\",\"13:0x0000000000000000000000000000000000000000:20000000000000000\",\"14:0x0000000000000000000000000000000000000000:10000000000000000\",\"15:0x0000000000000000000000000000000000000000:30000000000000000\",\"16:0x0000000000000000000000000000000000000000:10000000000000000\",\"17:0x0000000000000000000000000000000000000000:30000000000000000\",\"18:0x0000000000000000000000000000000000000000:10000000000000000\",\"19:0x0000000000000000000000000000000000000000:30000000000000000\",\"20:0x0000000000000000000000000000000000000000:10000000000000000\",\"21:0x0000000000000000000000000000000000000000:10000000000000000\",\"22:0x0000000000000000000000000000000000000000:10000000000000000\",\"23:0x0000000000000000000000000000000000000000:10000000000000000\",\"24:0x0000000000000000000000000000000000000000:10000000000000000\",\"25:0x0000000000000000000000000000000000000000:10000000000000000\",\"26:0x0000000000000000000000000000000000000000:10000000000000000\",\"27:0x0000000000000000000000000000000000000000:10000000000000000\",\"28:0x0000000000000000000000000000000000000000:10000000000000000\"]",
      "share_royalties":"0",
      "collection_logo_id":null,
      "collection_header_id":null,
      "chain_id":43113,
      "verified":null
   }
}
```

{% endtab %}
{% endtabs %}

## GET Multiple Collections

#### Example of request:

```
https://api.certhis.io/collections
```

{% tabs %}
{% tab title="REQUEST" %}
Query Parameters<br>

<table><thead><tr><th width="319">Parameter</th><th>Description</th></tr></thead><tbody><tr><td>per_page</td><td>the <code>int</code> representing how many collections per page (max 10)</td></tr><tr><td>page</td><td>the <code>int</code> representing page number</td></tr><tr><td>creator</td><td>the <code>string</code> representing the Creator Addres</td></tr><tr><td>label_index</td><td>the <code>int</code> representing Label Certhis Index</td></tr><tr><td>label_id</td><td>the <code>int</code> representing label smart contract id (need to be send with contract id)</td></tr><tr><td>contract_id</td><td>the <code>int</code> representing contract certhis id</td></tr><tr><td>search</td><td>the <code>string</code> representing the Search by Collection name</td></tr><tr><td>access_user</td><td>the <code>string</code> representing the user having access to the collection</td></tr></tbody></table>
{% endtab %}

{% tab title="RESPONSE" %}
Sample response

```
{
   "status":true,
   "message":"get_collections",
   "data":[
      {
         "id":249,
         "collection_logo":null,
         "collection_header":null,
         "collection_name":"test",
         "collection_symbole":"rtfk",
         "collection_description":"",
         "collection_tagline":"",
         "collection_instagram":"",
         "collection_twitter":"",
         "collection_discord":"",
         "root_price":"0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
         "collection_id":0,
         "label_id":0,
         "collection_address":"0x98746415ae5d7C6aEC6060f5d3c0C71cABB93f07",
         "collection_type":0,
         "collection_tax":0,
         "collection_payout":"0x7c78A82f71d6D7C9F14c4930F786F74Cd8171238",
         "certhis_tax":null,
         "certhis_payout":null,
         "certhis_tax_mint":null,
         "certhis_payout_mint":null,
         "mintable_activate":0,
         "price_for_mint":0,
         "collection_payout_mint":"0x7c78A82f71d6D7C9F14c4930F786F74Cd8171238",
         "created":"2022-08-10T12:36:21.000Z",
         "updated":"2023-01-04T13:22:40.000Z",
         "currency_for_mint":5295,
         "tax_descativate":5295,
         "allowance":null,
         "collection_full":1,
         "mint_start":0,
         "mint_end":0,
         "sell_id":0,
         "collection_uri":"https://private-nft.mypinata.cloud/ipfs/QmX1DNEvpfKi8PqiQqpvBefDaTAawWNcQq9q6vHabhVaPR",
         "max_mint":0,
         "max_mint_sell":0,
         "max_supply":20,
         "root":"0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
         "currency_object":{
            
         },
         "currency_object_tax_descativate":{
            
         },
         "whitelist":"[]",
         "affiliation":0,
         "collection_price":"[\"0:0x0000000000000000000000000000000000000000:0\",\"1:0x0000000000000000000000000000000000000000:0\",\"2:0x0000000000000000000000000000000000000000:0\",\"3:0x0000000000000000000000000000000000000000:0\",\"4:0x0000000000000000000000000000000000000000:0\",\"5:0x0000000000000000000000000000000000000000:0\",\"6:0x0000000000000000000000000000000000000000:0\",\"7:0x0000000000000000000000000000000000000000:0\",\"8:0x0000000000000000000000000000000000000000:0\",\"9:0x0000000000000000000000000000000000000000:0\",\"10:0x0000000000000000000000000000000000000000:0\",\"11:0x0000000000000000000000000000000000000000:0\",\"12:0x0000000000000000000000000000000000000000:0\",\"13:0x0000000000000000000000000000000000000000:0\",\"14:0x0000000000000000000000000000000000000000:0\",\"15:0x0000000000000000000000000000000000000000:0\",\"16:0x0000000000000000000000000000000000000000:0\",\"17:0x0000000000000000000000000000000000000000:0\",\"18:0x0000000000000000000000000000000000000000:0\",\"19:0x0000000000000000000000000000000000000000:0\"]",
         "share_royalties":0,
         "collection_logo_id":null,
         "collection_header_id":null,
         "chain_id":43113,
         "verified":null
      },
      {
         "id":250,
         "collection_logo":null,
         "collection_header":null,
         "collection_name":"test",
         "collection_symbole":"rtfk",
         "collection_description":"",
         "collection_tagline":"",
         "collection_instagram":"",
         "collection_twitter":"",
         "collection_discord":"",
         "root_price":"0xfbb836600bce7207952f5cc377436d99941ac2d4b8d068ed0999bc449c4864bc",
         "collection_id":1,
         "label_id":0,
         "collection_address":"0xEb97561A788618BaB84713bAf59c6367Fb546674",
         "collection_type":0,
         "collection_tax":0,
         "collection_payout":"0x7c78A82f71d6D7C9F14c4930F786F74Cd8171238",
         "certhis_tax":null,
         "certhis_payout":null,
         "certhis_tax_mint":null,
         "certhis_payout_mint":null,
         "mintable_activate":0,
         "price_for_mint":0,
         "collection_payout_mint":"0x7c78A82f71d6D7C9F14c4930F786F74Cd8171238",
         "created":"2022-08-10T12:48:21.000Z",
         "updated":"2022-10-20T15:12:57.000Z",
         "currency_for_mint":5295,
         "tax_descativate":5295,
         "allowance":null,
         "collection_full":2,
         "mint_start":0,
         "mint_end":0,
         "sell_id":0,
         "collection_uri":"https://private-nft.mypinata.cloud/ipfs/QmViqd8wd5NdtdRXhqs2Z2Wy2AA62DUUphk5CkKFbTjGKy",
         "max_mint":0,
         "max_mint_sell":0,
         "max_supply":29,
         "root":"0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
         "currency_object":{
            
         },
         "currency_object_tax_descativate":{
            
         },
         "whitelist":"[]",
         "affiliation":0,
         "collection_price":"[\"0:0x0000000000000000000000000000000000000000:10000000000000000\",\"1:0x0000000000000000000000000000000000000000:20000000000000000\",\"2:0x0000000000000000000000000000000000000000:10000000000000000\",\"3:0x0000000000000000000000000000000000000000:30000000000000000\",\"4:0x0000000000000000000000000000000000000000:10000000000000000\",\"5:0x0000000000000000000000000000000000000000:10000000000000000\",\"6:0x0000000000000000000000000000000000000000:10000000000000000\",\"7:0x0000000000000000000000000000000000000000:10000000000000000\",\"8:0x0000000000000000000000000000000000000000:30000000000000000\",\"9:0x0000000000000000000000000000000000000000:30000000000000000\",\"10:0x0000000000000000000000000000000000000000:30000000000000000\",\"11:0x0000000000000000000000000000000000000000:20000000000000000\",\"12:0x0000000000000000000000000000000000000000:20000000000000000\",\"13:0x0000000000000000000000000000000000000000:20000000000000000\",\"14:0x0000000000000000000000000000000000000000:10000000000000000\",\"15:0x0000000000000000000000000000000000000000:30000000000000000\",\"16:0x0000000000000000000000000000000000000000:10000000000000000\",\"17:0x0000000000000000000000000000000000000000:30000000000000000\",\"18:0x0000000000000000000000000000000000000000:10000000000000000\",\"19:0x0000000000000000000000000000000000000000:30000000000000000\",\"20:0x0000000000000000000000000000000000000000:10000000000000000\",\"21:0x0000000000000000000000000000000000000000:10000000000000000\",\"22:0x0000000000000000000000000000000000000000:10000000000000000\",\"23:0x0000000000000000000000000000000000000000:10000000000000000\",\"24:0x0000000000000000000000000000000000000000:10000000000000000\",\"25:0x0000000000000000000000000000000000000000:10000000000000000\",\"26:0x0000000000000000000000000000000000000000:10000000000000000\",\"27:0x0000000000000000000000000000000000000000:10000000000000000\",\"28:0x0000000000000000000000000000000000000000:10000000000000000\"]",
         "share_royalties":0,
         "collection_logo_id":null,
         "collection_header_id":null,
         "chain_id":43113,
         "verified":null
      }
   ]
}
```

{% endtab %}
{% endtabs %}

## GET Collection Assets

#### Example of request:

```
https://api.certhis.io/collection/attributes
```

{% tabs %}
{% tab title="REQUEST" %}
Query Parameters<br>

<table><thead><tr><th width="319">Parameter</th><th>Description</th></tr></thead><tbody><tr><td>collection_index</td><td>the <code>int</code> representing the ID of the Collection</td></tr></tbody></table>
{% endtab %}

{% tab title="RESPONSE" %}
Sample response

```
{
   "status":true,
   "message":"attributes_collection",
   "data":[
      {
         "trait_type":"color",
         "value":"purple",
         "nb_nft":1,
         "total_nft":20,
         "rarity":5
      },
      {
         "trait_type":"glance",
         "value":"up",
         "nb_nft":1,
         "total_nft":20,
         "rarity":5
      }
   ]
}
```

{% endtab %}
{% endtabs %}

## GET Multiple Collections

#### Example of request:

```
https://api.certhis.io/collections
```

{% tabs %}
{% tab title="REQUEST" %}
Query Parameters<br>

<table><thead><tr><th width="319">Parameter</th><th>Description</th></tr></thead><tbody><tr><td>per_page</td><td>the <code>int</code> representing how many collections per page (max 10)</td></tr><tr><td>page</td><td>the <code>int</code> representing page number</td></tr><tr><td>creator</td><td>the <code>string</code> representing the Creator Addres</td></tr><tr><td>label_index</td><td>the <code>int</code> representing Label Certhis Index</td></tr><tr><td>label_id</td><td>the <code>int</code> representing label smart contract id (need to be send with contract id)</td></tr><tr><td>contract_id</td><td>the <code>int</code> representing contract certhis id</td></tr><tr><td>search</td><td>the <code>string</code> representing the Search by Collection name</td></tr></tbody></table>
{% endtab %}

{% tab title="RESPONSE" %}
Sample response

```
{
   "status":true,
   "message":"get_collections",
   "data":[
      {
         "id":249,
         "collection_logo":null,
         "collection_header":null,
         "collection_name":"test",
         "collection_symbole":"rtfk",
         "collection_description":"",
         "collection_tagline":"",
         "collection_instagram":"",
         "collection_twitter":"",
         "collection_discord":"",
         "root_price":"0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
         "collection_id":0,
         "label_id":0,
         "collection_address":"0x98746415ae5d7C6aEC6060f5d3c0C71cABB93f07",
         "collection_type":0,
         "collection_tax":0,
         "collection_payout":"0x7c78A82f71d6D7C9F14c4930F786F74Cd8171238",
         "certhis_tax":null,
         "certhis_payout":null,
         "certhis_tax_mint":null,
         "certhis_payout_mint":null,
         "mintable_activate":0,
         "price_for_mint":0,
         "collection_payout_mint":"0x7c78A82f71d6D7C9F14c4930F786F74Cd8171238",
         "created":"2022-08-10T12:36:21.000Z",
         "updated":"2023-01-04T13:22:40.000Z",
         "currency_for_mint":5295,
         "tax_descativate":5295,
         "allowance":null,
         "collection_full":1,
         "mint_start":0,
         "mint_end":0,
         "sell_id":0,
         "collection_uri":"https://private-nft.mypinata.cloud/ipfs/QmX1DNEvpfKi8PqiQqpvBefDaTAawWNcQq9q6vHabhVaPR",
         "max_mint":0,
         "max_mint_sell":0,
         "max_supply":20,
         "root":"0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
         "currency_object":{
            
         },
         "currency_object_tax_descativate":{
            
         },
         "whitelist":"[]",
         "affiliation":0,
         "collection_price":"[\"0:0x0000000000000000000000000000000000000000:0\",\"1:0x0000000000000000000000000000000000000000:0\",\"2:0x0000000000000000000000000000000000000000:0\",\"3:0x0000000000000000000000000000000000000000:0\",\"4:0x0000000000000000000000000000000000000000:0\",\"5:0x0000000000000000000000000000000000000000:0\",\"6:0x0000000000000000000000000000000000000000:0\",\"7:0x0000000000000000000000000000000000000000:0\",\"8:0x0000000000000000000000000000000000000000:0\",\"9:0x0000000000000000000000000000000000000000:0\",\"10:0x0000000000000000000000000000000000000000:0\",\"11:0x0000000000000000000000000000000000000000:0\",\"12:0x0000000000000000000000000000000000000000:0\",\"13:0x0000000000000000000000000000000000000000:0\",\"14:0x0000000000000000000000000000000000000000:0\",\"15:0x0000000000000000000000000000000000000000:0\",\"16:0x0000000000000000000000000000000000000000:0\",\"17:0x0000000000000000000000000000000000000000:0\",\"18:0x0000000000000000000000000000000000000000:0\",\"19:0x0000000000000000000000000000000000000000:0\"]",
         "share_royalties":0,
         "collection_logo_id":null,
         "collection_header_id":null,
         "chain_id":43113,
         "verified":null
      },
      {
         "id":250,
         "collection_logo":null,
         "collection_header":null,
         "collection_name":"test",
         "collection_symbole":"rtfk",
         "collection_description":"",
         "collection_tagline":"",
         "collection_instagram":"",
         "collection_twitter":"",
         "collection_discord":"",
         "root_price":"0xfbb836600bce7207952f5cc377436d99941ac2d4b8d068ed0999bc449c4864bc",
         "collection_id":1,
         "label_id":0,
         "collection_address":"0xEb97561A788618BaB84713bAf59c6367Fb546674",
         "collection_type":0,
         "collection_tax":0,
         "collection_payout":"0x7c78A82f71d6D7C9F14c4930F786F74Cd8171238",
         "certhis_tax":null,
         "certhis_payout":null,
         "certhis_tax_mint":null,
         "certhis_payout_mint":null,
         "mintable_activate":0,
         "price_for_mint":0,
         "collection_payout_mint":"0x7c78A82f71d6D7C9F14c4930F786F74Cd8171238",
         "created":"2022-08-10T12:48:21.000Z",
         "updated":"2022-10-20T15:12:57.000Z",
         "currency_for_mint":5295,
         "tax_descativate":5295,
         "allowance":null,
         "collection_full":2,
         "mint_start":0,
         "mint_end":0,
         "sell_id":0,
         "collection_uri":"https://private-nft.mypinata.cloud/ipfs/QmViqd8wd5NdtdRXhqs2Z2Wy2AA62DUUphk5CkKFbTjGKy",
         "max_mint":0,
         "max_mint_sell":0,
         "max_supply":29,
         "root":"0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
         "currency_object":{
            
         },
         "currency_object_tax_descativate":{
            
         },
         "whitelist":"[]",
         "affiliation":0,
         "collection_price":"[\"0:0x0000000000000000000000000000000000000000:10000000000000000\",\"1:0x0000000000000000000000000000000000000000:20000000000000000\",\"2:0x0000000000000000000000000000000000000000:10000000000000000\",\"3:0x0000000000000000000000000000000000000000:30000000000000000\",\"4:0x0000000000000000000000000000000000000000:10000000000000000\",\"5:0x0000000000000000000000000000000000000000:10000000000000000\",\"6:0x0000000000000000000000000000000000000000:10000000000000000\",\"7:0x0000000000000000000000000000000000000000:10000000000000000\",\"8:0x0000000000000000000000000000000000000000:30000000000000000\",\"9:0x0000000000000000000000000000000000000000:30000000000000000\",\"10:0x0000000000000000000000000000000000000000:30000000000000000\",\"11:0x0000000000000000000000000000000000000000:20000000000000000\",\"12:0x0000000000000000000000000000000000000000:20000000000000000\",\"13:0x0000000000000000000000000000000000000000:20000000000000000\",\"14:0x0000000000000000000000000000000000000000:10000000000000000\",\"15:0x0000000000000000000000000000000000000000:30000000000000000\",\"16:0x0000000000000000000000000000000000000000:10000000000000000\",\"17:0x0000000000000000000000000000000000000000:30000000000000000\",\"18:0x0000000000000000000000000000000000000000:10000000000000000\",\"19:0x0000000000000000000000000000000000000000:30000000000000000\",\"20:0x0000000000000000000000000000000000000000:10000000000000000\",\"21:0x0000000000000000000000000000000000000000:10000000000000000\",\"22:0x0000000000000000000000000000000000000000:10000000000000000\",\"23:0x0000000000000000000000000000000000000000:10000000000000000\",\"24:0x0000000000000000000000000000000000000000:10000000000000000\",\"25:0x0000000000000000000000000000000000000000:10000000000000000\",\"26:0x0000000000000000000000000000000000000000:10000000000000000\",\"27:0x0000000000000000000000000000000000000000:10000000000000000\",\"28:0x0000000000000000000000000000000000000000:10000000000000000\"]",
         "share_royalties":0,
         "collection_logo_id":null,
         "collection_header_id":null,
         "chain_id":43113,
         "verified":null
      }
   ]
}
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.certhis.io/api-endpoints/collection.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.