Collections

What it a collection? 
A collection is a way to create a group of individual NFTs with similar attributes. All the NFTs belonging to the same collection share attributes like the artist, year of creation, social networks, name of the collection, etc.
Parameters
name: (Mandatory) Collection name. The collection name is internal to your Tangocrypto account. This is just a way to identify different collections. 
description: (Optional) Collection description. The collection description is internal to your Tangocrypto account.
url:  (Optional) URL of the website where the collection is going to be sold. 
payout_address:(Mandatory) Wallet address that is going to receive the payments of the NFT sale. This should be the wallet address of the seller. 
policy: (Mandatory) Policy configuration for every NFT in the collection. When you create a new collection we do several steps in the background; we create a new key pair (public verification key/private signing key), a policy script and the policy id. Then during the sale process, all the tokens are minted with the same policy script and the policy id is attached permanently to the NFT. 
lock: (Mandatory) true | false Defines if the policy will be locked or not. If you select falsethen you are not required to choose a date and time to lock the policy, therefore the policy will be open and you can be minting NFTs under this policy forever.  If you set this parameter to true then you have to specify a locktime date. 
locktime: (Optional) Locktime date in ISO 8601 format yyyy-mm-ddThh:mm:ss[.mmm]. It defines how long you'll be able to mint NFTs for the collection. The policy will lock after that date, and you won't be able to mint more NFTs using the same policy id (even if you use the same key). Hours and minutes are optional; if you set it to2022-02-24, it will automatically fill it with 0s, for example, 2022-02-24T00:00:00.000Z.
Take into consideration the desirability and size of your collection before setting this date and leave enough time for selling the NFTs. There is no limited time for the future.
metadata: (Optional) Metadata tags for the collection. The values between < > mean that they are tags. A tag is simply a variable that we will evaluate its value when you mint the NFT. You can use the metadata tag to define common attributes shared by all the NFTs in the collection, like the name, copyright, date issued, artist name, social media links, etc. Using metadata tags is not mandatory because you can define all the attributes while creating the individual NFTs. 
asset_name: (Mandatory) Metadata tag for the NFT asset name.
name: (Mandatory) Metadata tag for the NFT name.
description: (Optional) Metadata tag for the NFT description.
media_type: (Optional) Metadata tag for the media type.
files: (Optional) array of files used for files. This is used when you want to create an NFT with different file formats. For example, you can create several audio files and add them to the metadata. 
media_type: (Optional) Metadata tag for the media type.
name: (Optional) Metadata tag for the file name.
src: <file_link> (Optional) Image in base64 string to be hosted on IPFS.
attributes: (Optional) Custom attributes or traits for an NFT. You can create 2 types of attributes, fixed or variables. 
fixed: Use fixed attributes when you want every NFT in the collection to include the same key-value pair, and you don't want to define them NFT by NFT. For example, if you set a key with Ticker and the value with TANGO, then every NFT in your collection will have the attribute "Ticker":"TANGO". Other fixed attributes can be artist name, project name, Twitter, Discord, copyright etc. 
variables: Use variable attributes when you want every NFT in the collection to include the same key but with a different value. We use tags to represent a variable value, and they are surrounded by angle brackets. For example, if you set a key with accessory and the value with < accessory>, then every NFT will have the key accessory, and you'll have to define a tag and provide its value during the NFT creation. This allows you to change the value for individual NFTs during their creation while maintaining a uniform set of attributes across the collection.
Colection definition
The NFT Metadata Standard for Native Tokens is defined in CIP-0025. For a full reference visit https://github.com/cardano-foundation/CIPs/tree/master/CIP-0025​
Create collection example
HTTP
cURL
NodeJs
1
POST /<app-id>/v1/nft/collections HTTP/1.1
2
Host: cardano-testnet.tangocrypto.com
3
x-api-key: <your-api-key>
4
Content-Type: application/json
5
​
6
{
7
    "name": "Tangocrypto Collection",
8
    "description": "Tangocrypto collection description",
9
    "url": "https://www.tangocrypto.com",
10
    "payout_address": "addr_test1qpp33lzjgyzz6k86yy27kvkjepu8mfjy6g4l8rf2v8yjp4sla7h6txtvlevazp6jylz0w90y8yz0uec3cder28r47sssj9w2kd",
11
    "policy": {
12
        "lock": true,
13
        "lock_time": "2022-02-24"
14
        
15
    },
16
    "metadata": {
17
        "name": "<name>",
18
        "asset_name": "<asset_name>",
19
        "media_type": "<mime_type>",
20
        "description": "<description>",
21
        "files": [
22
          {
23
            "name": "<asset_name>",
24
            "media_type": "<mime_type>",
25
            "src": "<file_link>"
26
          }
27
        ],
28
        "attributes": {
29
            "color": "<color>",
30
            "body": "<body>",
31
            "eyes": "<eyes>",
32
            "face": "<face>",
33
            "accessory": "<accessory>",
34
            "collection": "Tangocrypto Collection",
35
            "artist": "Tangocrypto",
36
            "twitter": "https://twitter.com/tango_crypto",
37
            "website": "https://www.tangocrypto.com",
38
            "copyright": "Tangocrypto 2022"
39
        },
40
        "version": "1.0"
41
    }
42
}
Copied!
1
curl --location --request POST 'https://cardano-testnet.tangocrypto.com/<app-id>/v1/nft/collections' \
2
--header 'x-api-key: <your-api-key>' \
3
--header 'Content-Type: application/json' \
4
--data-raw '{
5
    "name": "Tango Collection",
6
    "description": "Tango collection description",
7
    "url": "https://www.tangocrypto.com",
8
    "payout_address": "addr_test1qp9mj7vnenx4v99hw7ztfq03n7dmmujpgtlyfjhhel9w67nk72usllcew208n60ym94xcptfrgytuy5apwp565x28jgsg0ztq3",
9
    "policy": {
10
        "lock": true,
11
        "lock_time": "2022-02-24"
12
    },
13
    "metadata": {
14
        "asset_name": "<asset_name>",
15
        "name": "<name>",
16
        "media_type": "<mime_type>",
17
        "description": "<description>",
18
        "files": [
19
          {
20
            "name": "<asset_name>",
21
            "media_type": "<mime_type>",
22
            "src": "<file_link>"
23
          }
24
        ],
25
        "attributes": {
26
            "color": "<color>",
27
            "body": "<body>",
28
            "eyes": "<eyes>",
29
            "face": "<face>",
30
            "accessory": "<accessory>",
31
            "collection": "Tangocrypto Collection",
32
            "artist": "Tangocrypto",
33
            "twitter": "https://twitter.com/tango_crypto",
34
            "copyright": "Tangocrypto 2021"
35
        },
36
        "version": "1.0"
37
    }
38
}'
Copied!
1
var axios = require('axios');
2
var data = JSON.stringify({
3
  "name": "Tango Collection",
4
  "description": "Tango collection description",
5
  "url": "https://www.tangocrypto.com",
6
  "payout_address": "addr_test1qpp33lzjgyzz6k86yy27kvkjepu8mfjy6g4l8rf2v8yjp4sla7h6txtvlevazp6jylz0w90y8yz0uec3cder28r47sssj9w2kd",
7
  "policy": {
8
    "lock": true,
9
    "lock_time": "2022-02-24"
10
  },
11
  "metadata": {
12
    "name": "<name>",
13
    "asset_name": "<asset_name>",
14
    "media_type": "<mime_type>",
15
    "description": "<description>",
16
    "files": [
17
      {
18
        "name": "<asset_name>",
19
        "media_type": "<mime_type>",
20
        "src": "<file_link>"
21
      }
22
    ],
23
    "attributes": {
24
      "color": "<color>",
25
      "body": "<body>",
26
      "eyes": "<eyes>",
27
      "face": "<face>",
28
      "accessory": "<accessory>",
29
      "collection": "Tangocrypto Collection",
30
      "artist": "Tangocrypto",
31
      "twitter": "https://twitter.com/tango_crypto",
32
      "copyright": "Tangocrypto 2021"
33
    },
34
    "version": "1.0"
35
  }
36
});
37
​
38
var config = {
39
  method: 'post',
40
  url: 'https://cardano-testnet.tangocrypto.com/<app-id>/v1/nft/collections',
41
  headers: { 
42
    'x-api-key': '<your-api-key>', 
43
    'Content-Type': 'application/json'
44
  },
45
  data: data
46
};
47
​
48
axios(config)
49
.then(function (response) {
50
  console.log(JSON.stringify(response.data));
51
})
52
.catch(function (error) {
53
  console.log(error);
54
});
55
​
Copied!
Response
This endpoint returns the policy_id. You should post the policy id in your website, social media or any communication channel, you use for buyers to verify the authenticity of the tokens they buy.
1
{
2
    "id": "e1d7fe1d97c64518a5c51011edcc1a31",
3
    "name": "Tango Collection",
4
    "url": "https://www.tangocrypto.com",
5
    "description": "Tango collection description",
6
    "payout_address": "addr_test1qpp33lzjgyzz6k86yy27kvkjepu8mfjy6g4l8rf2v8yjp4sla7h6txtvlevazp6jylz0w90y8yz0uec3cder28r47sssj9w2kd",
7
    "token_count": 0,
8
    "token_for_sale_count": 0,
9
    "token_sold_count": 0,
10
    "revenue": 0,
11
    "income": 0,
12
    "service_fee": 0,
13
    "nft_fee": 0,
14
    "tx_fee": 0,
15
    "total_fees": 0,
16
    "policy": {
17
        "lock": true,
18
        "lock_time": "2022-02-24T00:00:00.000Z",
19
        "policy_id": "6a16d7d312dfcbcb4f676fa31893cf6c456508d84472309f3aa7c998",
20
        "script": {
21
            "type": "all",
22
            "scripts": [
23
                {
24
                    "type": "sig",
25
                    "keyHash": "76bcc8cf947649636f027e705a30ec66fa0476971aef51d219323c07"
26
                },
27
                {
28
                    "type": "before",
29
                    "slot": 54094491
30
                }
31
            ]
32
        }
33
    },
34
    "metadata": {
35
        "label": "721",
36
        "asset_name": "<asset_name>",
37
        "name": "<name>",
38
        "media_type": "<mime_type>",
39
        "description": "<description>",
40
        "files": [
41
            {
42
                "name": "<asset_name>",
43
                "media_type": "<mime_type>",
44
                "src": "<file_link_1>"
45
            }
46
        ],
47
        "attributes": {
48
            "color": "<color>",
49
            "body": "<body>",
50
            "eyes": "<eyes>",
51
            "face": "<face>",
52
            "accessory": "<accessory>",
53
            "collection": "Tangocrypto Collection",
54
            "artist": "Tangocrypto",
55
            "twitter": "https://twitter.com/tango_crypto",
56
            "website": "https://www.tangocrypto.com",
57
            "copyright": "Tangocrypto 2022"
58
        },
59
        "version": "1.0"
60
    },
61
    "created_at": "2022-02-23T08:21:38.908Z",
62
    "updated_at": "2022-02-23T08:21:38.908Z"
63
}
Copied!
Getting Started
Tokens
Last modified 14d ago
Copy link
Contents
What it a collection?