# Collection API
### Get list of supported NFT collections
```
## Request
curl -X "GET" "https://oracle-api.banksea.finance/nft/v1/collection/list" \
-H 'x-api-key: test-api-key' \
-H 'Content-Type: application/json; charset=utf-8'
```
* Interface: /nft/v1/collection/list
* Method: GET
* Data Format: JSON
* Response Data:
| Field | Type | Description |
| ---------- | ------ | --------------------------------------------------- |
| collection | String | The NFT collection. |
| name | String | The name of the NFT collection. |
| verified | String | The verified creator address of the NFT collection. |
| symbol | String | The symbol of the NFT collection. |
* Response Example:
```json
{
"success": true,
"code": "200",
"message": "success",
"data": [
{
"collection": "citizenone",
"name": "CitizenOne",
"verified": "4LVBRxUgQhJ8ZWn48SkJ4pgcNeZJekhSxq1uatDVUyoS",
"symbol": "CTN"
}
]
}
```
### Get NFT collection information
```
## Request
curl -X "POST" "https://oracle-api.banksea.finance/nft/v1/collection" \
-H 'x-api-key: test-api-key' \
-H 'Content-Type: application/json; charset=utf-8' \
-d $'{
"collection":"citizenone"
}'
```
* Interface: /nft/v1/collection
* Method: POST
* Data Format: JSON
* Request Parameter:
| Parameter | Type | Required | Description |
| ---------- | ------ | -------- | ------------------- |
| collection | String | Y | The NFT collection. |
* Request Example:
```
{
"collection":"citizenone"
}
```
* Response Data:
| Field | Type | Description |
| ----------------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| name | String | The name of the NFT collection. |
| verified | String | The verified creator address of the NFT collection. |
| symbol | String | The symbol of the NFT collection. |
| description | String | The description of the NFT collection. |
| image\_url | String | The image url of the NFT collection. |
| external\_url | String | The external url of the NFT collection. |
| discord\_url | String | The discord url of the NFT collection. |
| twitter\_url | String | The twitter url of the NFT collection. |
| items | Number | The items number of the NFT collection. |
| sales\_7\_days | Number | The number of transactions to buy the NFTs of the collection over the past 7 days. |
| liquidity\_7\_days | Number | The liquidity rate measures the relative liquidity of each collection over the past 7 days. liquidity\_7\_days = sales\_7\_days / The number of NFTs \* 100%. |
| volume\_24\_hours | Number | Total volume of NFT sales of the collection over the past 24 hours. |
| avg\_price\_24\_hours | Number | Average price of NFT sales of the collection over the past 24 hours. |
| volume\_7\_days | Number | Total volume of NFT sales of the collection over the past 7 days. |
| avg\_price\_7\_days | Number | Average price of NFT sales of the collection over the past 7 days. |
| market\_cap | Number | The market capitalization based on the last price of each NFT in this collection. |
| market\_cap\_change | Object | The variation of the collection market cap over the past 24 hours, 7 days and 30 days. |
| market\_cap\_change.rate\_24\_hours | Number | The variation of the collection market cap over the past 24 hours |
| market\_cap\_change.rate\_7\_days | Number | The variation of the collection market cap over the past 7 days. |
| market\_cap\_change.rate\_30\_days | Number | The variation of the collection market cap over the past 30 days. |
| floor\_price | Number | The floor price. |
| collection\_popularity | Number | The collection popularity refers to the attention of the NFT series in the entire NFT market. |
| market\_popularity | Number | The popularity of the market is calculated based on the statistics of BTC and ETC's one-day trading volume and market value in the past time. The TR (turnover rate), which is used to indicate the market heat. |
| media\_popularity | Number | Based on the variation in the number of historical fans, tweets, subscribers and other indicators on social media, media popularity is generated comprehensively. |
| attribute\_popularity | List | The collection attribute popularity top 50. |
| attribute\_popularity.trait\_type | String | Attribute type. |
| attribute\_popularity.value | String | Attribute value. |
| attribute\_popularity.popularity | Number | Attribute popularity. |
* Response Example:
```json
{
"success": true,
"code": "200",
"message": "success",
"data": {
"description": "Banksea released the 1,781 limited Genesis NFT, CitizenOne. They are important building blocks for community members to participate in the project. CitizenOne Holders will be whitelisted for allocation in our upcoming IDO. Other PRIVILEGES include: The collection will be added directly to the whitelist of NFT Oracle. The price of each CitizenOne will be assessed by Banksea NFT Oracle, which enables them to be collateralized for loans on the platform. Meanwhile, CitizenOne can be staked for mining in Banksea and be used for token airdrop raffle tickets.",
"name": "CitizenOne",
"verified": "4LVBRxUgQhJ8ZWn48SkJ4pgcNeZJekhSxq1uatDVUyoS",
"symbol": "CTN",
"image_url": "https://pbs.twimg.com/profile_images/1506954108749565952/1rYtnjKG_200x200.jpg",
"external_url": "https://nft.banksea.finance/",
"discord_url": "https://discord.com/invite/NdRGt4BDFe",
"twitter_url": "https://twitter.com/banksea_finance",
"items": 1781,
"floor_price": 1.900000,
"sales_7_days": 16,
"liquidity_7_days": 0.0090,
"volume_7_days": 35.030000000,
"avg_price_7_days": 2.1894,
"volume_24_hours": 11.190000000,
"avg_price_24_hours": 1.8650,
"market_cap": 1398.0378111110,
"market_cap_change": {
"rate_24_hours": 0.000000,
"rate_7_days": 0.000000,
"rate_30_days": 0.000000
},
"collection_popularity": 60.6495,
"market_popularity": 35.6438,
"media_popularity": 88.7029,
"attribute_popularity": [
{
"value": "Yellow",
"popularity": 88.720481346,
"trait_type": "Body"
},
{
"value": "Blue",
"popularity": 87.082017469,
"trait_type": "Background"
},
{
"value": "Joker",
"popularity": 86.964741427,
"trait_type": "Mouth"
},
{
"value": "Smoke",
"popularity": 86.791146717,
"trait_type": "Mouth"
},
{
"value": "Flower Badge",
"popularity": 86.791146717,
"trait_type": "Energy"
},
{
"value": "Anaglyphic",
"popularity": 86.661290759,
"trait_type": "Eye"
},
{
"value": "Short Hair",
"popularity": 86.603187418,
"trait_type": "Head"
},
{
"value": "Skeleton",
"popularity": 86.266409086,
"trait_type": "Body Feature"
},
{
"value": "Meta Goggle",
"popularity": 86.122460790,
"trait_type": "Eye"
},
{
"value": "Silver",
"popularity": 86.005837317,
"trait_type": "Body"
},
{
"value": "BART KUAR",
"popularity": 85.682485931,
"trait_type": "Body Feature"
},
{
"value": "Brown",
"popularity": 85.390691285,
"trait_type": "Body"
},
{
"value": "Bat",
"popularity": 85.350260018,
"trait_type": "Back"
},
{
"value": "Spade",
"popularity": 84.955123240,
"trait_type": "Back"
},
{
"value": "Triangle",
"popularity": 84.744669956,
"trait_type": "Eye"
},
{
"value": "Yellow Neck",
"popularity": 84.635974304,
"trait_type": "Neck"
},
{
"value": "Wire Neck",
"popularity": 84.468376538,
"trait_type": "Neck"
},
{
"value": "Red 23",
"popularity": 84.341856657,
"trait_type": "Body Feature"
},
{
"value": "Dark Green",
"popularity": 84.245349304,
"trait_type": "Background"
},
{
"value": "Helmet",
"popularity": 84.176204189,
"trait_type": "Helmet"
},
{
"value": "Gun",
"popularity": 84.029913698,
"trait_type": "Back"
},
{
"value": "Rabbit",
"popularity": 84.010974304,
"trait_type": "Shoulder"
},
{
"value": "Police",
"popularity": 84.003062911,
"trait_type": "Body Feature"
},
{
"value": "Seagull",
"popularity": 83.866743534,
"trait_type": "Shoulder"
},
{
"value": "Pattern",
"popularity": 83.773905338,
"trait_type": "Body Feature"
},
{
"value": "Love Energy",
"popularity": 83.552640970,
"trait_type": "Energy"
},
{
"value": "Alien Helmet",
"popularity": 83.538413328,
"trait_type": "Helmet"
},
{
"value": "Gold 8",
"popularity": 83.476554014,
"trait_type": "Body Feature"
},
{
"value": "Besom",
"popularity": 83.465761538,
"trait_type": "Back"
},
{
"value": "Keyboard",
"popularity": 83.260974304,
"trait_type": "Back"
},
{
"value": "Red",
"popularity": 83.106562539,
"trait_type": "Body"
},
{
"value": "Mouse",
"popularity": 82.969307637,
"trait_type": "Shoulder"
},
{
"value": "Detector",
"popularity": 82.969307637,
"trait_type": "Shoulder"
},
{
"value": "Pentagram",
"popularity": 82.969307637,
"trait_type": "Body Feature"
},
{
"value": "T Energy",
"popularity": 82.871268421,
"trait_type": "Energy"
},
{
"value": "Metal",
"popularity": 82.804988388,
"trait_type": "Body"
},
{
"value": "Rusted",
"popularity": 82.771567524,
"trait_type": "Body"
},
{
"value": "None",
"popularity": 82.766815425,
"trait_type": "Head"
},
{
"value": "None",
"popularity": 82.766815425,
"trait_type": "Ear"
},
{
"value": "Robot Energy",
"popularity": 82.760974304,
"trait_type": "Energy"
},
{
"value": "Orange",
"popularity": 82.704156122,
"trait_type": "Background"
},
{
"value": "Trip",
"popularity": 82.434139441,
"trait_type": "Eye"
},
{
"value": "None",
"popularity": 82.421209203,
"trait_type": "Helmet"
},
{
"value": "Racket",
"popularity": 82.328281996,
"trait_type": "Back"
},
{
"value": "Caution",
"popularity": 82.283033127,
"trait_type": "Mouth"
},
{
"value": "Samurai",
"popularity": 82.283033127,
"trait_type": "Mouth"
},
{
"value": "Squirrel",
"popularity": 82.246593773,
"trait_type": "Shoulder"
},
{
"value": "TaiChi Energy",
"popularity": 82.224626786,
"trait_type": "Energy"
},
{
"value": "Navy Blue",
"popularity": 82.216619465,
"trait_type": "Body"
},
{
"value": "Blue 30",
"popularity": 82.098660871,
"trait_type": "Body Feature"
}
]
}
}
```
### Get NFT collection basic information
```
## Request
curl -X "POST" "https://oracle-api.banksea.finance/nft/v1/collection/info" \
-H 'x-api-key: test-api-key' \
-H 'Content-Type: application/json; charset=utf-8' \
-d $'{
"collection":"citizenone"
}'
```
* Interface: /nft/v1/collection/info
* Method: POST
* Data Format: JSON
* Request Parameter:
| Parameter | Type | Required | Description |
| ---------- | ------ | -------- | ------------------- |
| collection | String | Y | The NFT collection. |
* Request Example:
```
{
"collection":"citizenone"
}
```
* Response Data:
| Field | Type | Description |
| ------------- | ------ | --------------------------------------------------- |
| name | String | The name of the NFT collection. |
| verified | String | The verified creator address of the NFT collection. |
| symbol | String | The symbol of the NFT collection. |
| description | String | The description of the NFT collection. |
| image\_url | String | The image url of the NFT collection. |
| external\_url | String | The external url of the NFT collection. |
| discord\_url | String | The discord url of the NFT collection. |
| twitter\_url | String | The twitter url of the NFT collection. |
| items | Number | The items number of the NFT collection. |
* Response Example:
```
{
"success": true,
"code": "200",
"message": "success",
"data": {
"description": "Banksea released the 1,781 limited Genesis NFT, CitizenOne. They are important building blocks for community members to participate in the project. CitizenOne Holders will be whitelisted for allocation in our upcoming IDO. Other PRIVILEGES include: The collection will be added directly to the whitelist of NFT Oracle. The price of each CitizenOne will be assessed by Banksea NFT Oracle, which enables them to be collateralized for loans on the platform. Meanwhile, CitizenOne can be staked for mining in Banksea and be used for token airdrop raffle tickets.",
"name": "CitizenOne",
"verified": "4LVBRxUgQhJ8ZWn48SkJ4pgcNeZJekhSxq1uatDVUyoS",
"symbol": "CTN",
"image_url": "https://pbs.twimg.com/profile_images/1506954108749565952/1rYtnjKG_200x200.jpg",
"external_url": "https://nft.banksea.finance/",
"discord_url": "https://discord.com/invite/NdRGt4BDFe",
"twitter_url": "https://twitter.com/banksea_finance",
"items": 1781
}
}
```
### Get NFT collection market cap
```
## Request
curl -X "POST" "https://oracle-api.banksea.finance/nft/v1/collection/market_cap" \
-H 'x-api-key: test-api-key' \
-H 'Content-Type: application/json; charset=utf-8' \
-d $'{
"collection":"citizenone"
}'
```
* Interface: /nft/v1/collection/market\_cap
* Method: POST
* Data Format: JSON
* Request Parameter:
| Parameter | Type | Required | Description |
| ---------- | ------ | -------- | ------------------- |
| collection | String | Y | The NFT collection. |
* Request Example:
```
{
"collection":"citizenone"
}
```
* Response Data:
| Field | Type | Description |
| ----------------------------------- | ------ | -------------------------------------------------------------------------------------- |
| market\_cap | Number | The market capitalization based on the last price of each NFT in this collection. |
| market\_cap\_change | Object | The variation of the collection market cap over the past 24 hours, 7 days and 30 days. |
| market\_cap\_change.rate\_24\_hours | Number | The variation of the collection market cap over the past 24 hours |
| market\_cap\_change.rate\_7\_days | Number | The variation of the collection market cap over the past 7 days. |
| market\_cap\_change.rate\_30\_days | Number | The variation of the collection market cap over the past 30 days. |
| floor\_price | Number | The floor price. |
* Response Example:
```json
{
"success": true,
"code": "200",
"message": "success",
"data": {
"floor_price": 1.900000,
"market_cap": 1398.0378111110,
"market_cap_change": {
"rate_24_hours": 0.000000,
"rate_7_days": 0.000000,
"rate_30_days": 0.000000
}
}
}
```
### Get NFT collection popularity
```
## Request
curl -X "POST" "https://oracle-api.banksea.finance/nft/v1/collection/popularity" \
-H 'x-api-key: test-api-key' \
-H 'Content-Type: application/json; charset=utf-8' \
-d $'{
"collection":"citizenone"
}'
```
* Interface: /nft/v1/collection/popularity
* Method: POST
* Data Format: JSON
* Request Parameter:
| Parameter | Type | Required | Description |
| ---------- | ------ | -------- | ------------------- |
| collection | String | Y | The NFT collection. |
* Request Example:
```
{
"collection":"citizenone"
}
```
* Response Data:
| Field | Type | Description |
| --------------------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| collection\_popularity | Number | The collection popularity refers to the attention of the NFT series in the entire NFT market. |
| media\_popularity | Number | Based on the variation in the number of historical fans, tweets, subscribers and other indicators on social media, media popularity is generated comprehensively. |
| attribute\_popularity | List | The collection attribute popularity top 50. |
| attribute\_popularity.trait\_type | String | Attribute type. |
| attribute\_popularity.value | String | Attribute value. |
| attribute\_popularity.popularity | Number | Attribute popularity. |
* Response Example:
```json
{
"success": true,
"code": "200",
"message": "success",
"data": {
"collection_popularity": 60.6495,
"media_popularity": 88.7029,
"attribute_popularity": [
{
"value": "Yellow",
"popularity": 88.720481346,
"trait_type": "Body"
},
{
"value": "Blue",
"popularity": 87.082017469,
"trait_type": "Background"
},
{
"value": "Joker",
"popularity": 86.964741427,
"trait_type": "Mouth"
},
{
"value": "Smoke",
"popularity": 86.791146717,
"trait_type": "Mouth"
},
{
"value": "Flower Badge",
"popularity": 86.791146717,
"trait_type": "Energy"
},
{
"value": "Anaglyphic",
"popularity": 86.661290759,
"trait_type": "Eye"
},
{
"value": "Short Hair",
"popularity": 86.603187418,
"trait_type": "Head"
},
{
"value": "Skeleton",
"popularity": 86.266409086,
"trait_type": "Body Feature"
},
{
"value": "Meta Goggle",
"popularity": 86.122460790,
"trait_type": "Eye"
},
{
"value": "Silver",
"popularity": 86.005837317,
"trait_type": "Body"
},
{
"value": "BART KUAR",
"popularity": 85.682485931,
"trait_type": "Body Feature"
},
{
"value": "Brown",
"popularity": 85.390691285,
"trait_type": "Body"
},
{
"value": "Bat",
"popularity": 85.350260018,
"trait_type": "Back"
},
{
"value": "Spade",
"popularity": 84.955123240,
"trait_type": "Back"
},
{
"value": "Triangle",
"popularity": 84.744669956,
"trait_type": "Eye"
},
{
"value": "Yellow Neck",
"popularity": 84.635974304,
"trait_type": "Neck"
},
{
"value": "Wire Neck",
"popularity": 84.468376538,
"trait_type": "Neck"
},
{
"value": "Red 23",
"popularity": 84.341856657,
"trait_type": "Body Feature"
},
{
"value": "Dark Green",
"popularity": 84.245349304,
"trait_type": "Background"
},
{
"value": "Helmet",
"popularity": 84.176204189,
"trait_type": "Helmet"
},
{
"value": "Gun",
"popularity": 84.029913698,
"trait_type": "Back"
},
{
"value": "Rabbit",
"popularity": 84.010974304,
"trait_type": "Shoulder"
},
{
"value": "Police",
"popularity": 84.003062911,
"trait_type": "Body Feature"
},
{
"value": "Seagull",
"popularity": 83.866743534,
"trait_type": "Shoulder"
},
{
"value": "Pattern",
"popularity": 83.773905338,
"trait_type": "Body Feature"
},
{
"value": "Love Energy",
"popularity": 83.552640970,
"trait_type": "Energy"
},
{
"value": "Alien Helmet",
"popularity": 83.538413328,
"trait_type": "Helmet"
},
{
"value": "Gold 8",
"popularity": 83.476554014,
"trait_type": "Body Feature"
},
{
"value": "Besom",
"popularity": 83.465761538,
"trait_type": "Back"
},
{
"value": "Keyboard",
"popularity": 83.260974304,
"trait_type": "Back"
},
{
"value": "Red",
"popularity": 83.106562539,
"trait_type": "Body"
},
{
"value": "Mouse",
"popularity": 82.969307637,
"trait_type": "Shoulder"
},
{
"value": "Detector",
"popularity": 82.969307637,
"trait_type": "Shoulder"
},
{
"value": "Pentagram",
"popularity": 82.969307637,
"trait_type": "Body Feature"
},
{
"value": "T Energy",
"popularity": 82.871268421,
"trait_type": "Energy"
},
{
"value": "Metal",
"popularity": 82.804988388,
"trait_type": "Body"
},
{
"value": "Rusted",
"popularity": 82.771567524,
"trait_type": "Body"
},
{
"value": "None",
"popularity": 82.766815425,
"trait_type": "Head"
},
{
"value": "None",
"popularity": 82.766815425,
"trait_type": "Ear"
},
{
"value": "Robot Energy",
"popularity": 82.760974304,
"trait_type": "Energy"
},
{
"value": "Orange",
"popularity": 82.704156122,
"trait_type": "Background"
},
{
"value": "Trip",
"popularity": 82.434139441,
"trait_type": "Eye"
},
{
"value": "None",
"popularity": 82.421209203,
"trait_type": "Helmet"
},
{
"value": "Racket",
"popularity": 82.328281996,
"trait_type": "Back"
},
{
"value": "Caution",
"popularity": 82.283033127,
"trait_type": "Mouth"
},
{
"value": "Samurai",
"popularity": 82.283033127,
"trait_type": "Mouth"
},
{
"value": "Squirrel",
"popularity": 82.246593773,
"trait_type": "Shoulder"
},
{
"value": "TaiChi Energy",
"popularity": 82.224626786,
"trait_type": "Energy"
},
{
"value": "Navy Blue",
"popularity": 82.216619465,
"trait_type": "Body"
},
{
"value": "Blue 30",
"popularity": 82.098660871,
"trait_type": "Body Feature"
}
]
}
}
```
### Get NFT collection volume
```
## Request
curl -X "POST" "https://oracle-api.banksea.finance/nft/v1/collection/volume" \
-H 'x-api-key: test-api-key' \
-H 'Content-Type: application/json; charset=utf-8' \
-d $'{
"collection":"citizenone"
}'
```
* Interface: /nft/v1/collection/volume
* Method: POST
* Data Format: JSON
* Request Parameter:
| Parameter | Type | Required | Description |
| ---------- | ------ | -------- | ------------------- |
| collection | String | Y | The NFT collection. |
* Request Example:
```
{
"collection":"citizenone"
}
```
* Response Data:
| Field | Type | Description |
| --------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| sales\_7\_days | Number | The number of transactions to buy the NFTs of the collection over the past 7 days. |
| liquidity\_7\_days | Number | The liquidity rate measures the relative liquidity of each collection over the past 7 days. liquidity\_7\_days = sales\_7\_days / The number of NFTs \* 100%. |
| volume\_24\_hours | Number | Total volume of NFT sales of the collection over the past 24 hours. |
| avg\_price\_24\_hours | Number | Average price of NFT sales of the collection over the past 24 hours. |
| volume\_7\_days | Number | Total volume of NFT sales of the collection over the past 7 days. |
| avg\_price\_7\_days | Number | Average price of NFT sales of the collection over the past 7 days. |
* Response Example:
```json
{
"success": true,
"code": "200",
"message": "success",
"data": {
"sales_7_days": 16,
"liquidity_7_days": 0.0090,
"volume_7_days": 35.030000000,
"avg_price_7_days": 2.1894,
"volume_24_hours": 11.190000000,
"avg_price_24_hours": 1.8650
}
}
```