Backoffice Admin API
GET
/projects
GET
/projects/
{id}
GET
/projects/
{id}/carbon
GET
/projects/
{id}/collections
GET
/projects/
{id}/creatures
GET
/projects/
{id}/offers
GET
/projects
List of all projects across multiple organisations
Request parameters
organisation_id
string
optional
Responses
200
200
OK
Body
Object
content
Array
Object
id
string
Example:
69de6a72-2797-11ed-b110-42010a9a0008
name
string
Example:
Kariba REDD+ Project
description
string
Example:
The Kariba REDD+ Project will generate approximately 196,500,000 carbon credits from reduced emissions associated with deforestation over 30 years. The reduction in deforestation “will be achieved through a series of activities that are designed to significantly improve the livelihoods of locals
account
Object
The account that is aggregating the projects
id
string
name
string
description
string
owner
Object
The Beneficial Owner of the Project
id
string
69de6a72-2797-11ed-b110-42010a9a0008
name
string
Carbon Streaming
description
string
Carbon Streaming owner of multiple projects
carbon
Array
Details of Carbon Blocks
Object
id
string
ID of the carbon inventory
name
string
Carbon Inventory Name
vintage
Object
Vintage of carbon
from_date
string
to_date
string
unit_type
string
Example:
VCU
costs
Object
unit_cost
number
pricing
Array
Prices for Carbon
Object
id
string
Example:
95ac16e3-c194-11ec-a97e-42010a9a0008
name
string
Example:
Island Innovation NFT
price_model
string
Example:
FLAT
sales_prices
Array
Object
id
string
Example:
38186aea-c18d-11ec-a97e-42010a9a0008
location_code
string
Example:
UK
currency
string
Example:
USDC
display_price
string
Example:
$40.00
effective_date
integer
Example:
1650557281
price
integer
Example:
40
tax_model
string
Example:
INCLUSIVE
block
Object
Block Numbers for given carbon
start_block
number
end_block
number
total_blocks
number
creatives
Array
Object
id
string
Example:
0e02f4ab-797c-405c-8bf7-14651e28fe05
usage_type
Object
id
string
ID of usage type
name
string
HERO
width
integer
Example:
259
format
string
Example:
jpg
media
Object
id
string
medias
Array
Object
width
integer
Example:
50
height
integer
Example:
37
url
string
Example:
https://res.cloudinary.com/image/upload/c_scale,f_auto,q_auto,w_50/v1/bg/v6z5d9dq7wktaqmm5nbm.jpg
url
string
Example:
https://res.cloudinary.com/vizulink-tech-lmimited/image/upload/v1/bg/v6z5d9dq7wktaqmm5nbm.jpg
height
integer
Example:
194
media_group
Object
id
string
name
string
public_id
string
Example:
bg/v6z5d9dq7wktaqmm5nbm
location
paging
Object
page_number
integer
page_size
integer
Example:
10
total_elements
integer
Example:
4
total_pages
integer
Example:
1
Example 1
GET /projects HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "69de6a72-2797-11ed-b110-42010a9a0008",
"name": "Kariba REDD+ Project",
"description": "The Kariba REDD+ Project will generate approximately 196,500,000 carbon credits from reduced emissions associated with deforestation over 30 years. The reduction in deforestation “will be achieved through a series of activities that are designed to significantly improve the livelihoods of locals",
"account": {
"id": "",
"name": "",
"description": ""
},
"owner": {
"id": "",
"name": "",
"description": ""
},
"carbon": [
{
"id": "",
"name": "",
"vintage": {
"from_date": "",
"to_date": ""
},
"unit_type": "VCU",
"costs": {
"unit_cost": 1
},
"pricing": [
{
"id": "95ac16e3-c194-11ec-a97e-42010a9a0008",
"name": "Island Innovation NFT",
"price_model": "FLAT",
"sales_prices": [
{
"id": "38186aea-c18d-11ec-a97e-42010a9a0008",
"location_code": "UK",
"currency": "USDC",
"display_price": "$40.00",
"effective_date": 1650557281,
"price": 40,
"tax_model": "INCLUSIVE"
}
]
}
],
"block": {
"start_block": 1,
"end_block": 1,
"total_blocks": 1
}
}
],
"creatives": [
{
"id": "0e02f4ab-797c-405c-8bf7-14651e28fe05",
"usage_type": {
"id": "",
"name": ""
},
"width": 259,
"format": "jpg",
"media": {
"id": ""
},
"medias": [
{
"width": 50,
"height": 37,
"url": "https://res.cloudinary.com/image/upload/c_scale,f_auto,q_auto,w_50/v1/bg/v6z5d9dq7wktaqmm5nbm.jpg"
}
],
"url": "https://res.cloudinary.com/vizulink-tech-lmimited/image/upload/v1/bg/v6z5d9dq7wktaqmm5nbm.jpg",
"height": 194,
"media_group": {
"id": "",
"name": ""
},
"public_id": "bg/v6z5d9dq7wktaqmm5nbm"
}
],
"location": {
"geo": {
"lat": "",
"lon": ""
},
"continent": "",
"country": "",
"region": ""
}
}
],
"paging": {
"page_number": 1,
"page_size": 10
},
"total_elements": 4,
"total_pages": 1
}
GET
/projects/
{id}Path variables
id
string
required
Responses
200
200
OK
Body
Object
id
string
Example:
69de6a72-2797-11ed-b110-42010a9a0008
name
string
Example:
Gola Rainforest
description
string
Example:
The largest remaining area of Upper Guinea rainforest in Sierra Leone, home to chimpanzees, hippos, and forest elephants.
long_description
string
Example:
The Mai Ndombe REDD+ Project protects 300,000 hectares (740,000 acres) of critical bonobo and forest elephant habitat within the world’s second-largest intact rainforest and some of the most important wetlands on the planet, the Congo Basin. This project reduces the principal drivers of forest and biodiversity loss and is charting a new pathway for community prosperity through comprehensive investments into the surrounding local communities, which are among the most impoverished in the world.
organisation
Object
id
string
69de6a72-2797-11ed-b110-42010a9a0008
name
string
Stand For Trees
description
string
location
creatives
GET
/projects/
{id}/carbonPath variables
id
string
required
Responses
200
200
OK
Body
Example 1
GET /projects/{id}/carbon HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
[
{
"id": "",
"name": "",
"vintage": {
"vintage": "2014 - 2016",
"vintage_from": 1,
"vintage_to": 1
},
"unit_type": "VCU",
"purchase_date": 1,
"carbon": {
"open_balance": 1,
"current_balance": 1
},
"costs": {
"purchase_price": 1,
"currency": "USD"
},
"serial_number": "",
"supplier": {
"id": "",
"name": ""
},
"consigned": {
"id": "",
"name": ""
},
"verifier_reference": ""
}
]
GET
/projects/
{id}/collectionsPath variables
id
string
required
Responses
200
200
OK
Body
Array
Object
id
string
name
string
base_url
string
contract
Object
address
string
abi
string
is_mc
string
blockchain
Object
network
string
Example 1
GET /projects/{id}/collections HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
[
{
"id": "",
"name": "",
"base_url": "",
"contract": {
"address": "",
"abi": "",
"is_mc": "",
"blockchain": {
"network": ""
}
},
"attributes": [
{
"id": "",
"nft_type": "MERCHANDISE",
"name": "rarity",
"description": "",
"attribute_value": "Critically Endangered",
"lexicon": "nft.rarity",
"iso639-2": "eng",
"attribute_type": "NUMERIC"
}
]
}
]
GET
/projects/
{id}/creaturesPath variables
id
string
required
Responses
200
OK
Body
GET
/retirements
POST
/retirements
GET
/projects/
{id}/retirements
GET
/contacts/
{id}/retirements
GET
/retirements
Gets a list of retirements recorded in MC dbms and the certificates from the IHS or VERA registry
Request parameters
project_id
string
optional
List of Project ID’s for filter
start_date
string
optional
Start Date for filter
end_date
string
optional
Ed Date for filter
Request headers
api_key
string
optional
Used for Server to Server API
Responses
200
200
OK
Body
Object
content
Array
Object
id
string
Example:
69de6a72-2797-11ed-b110-42010a9a0008
retirement_date
number
serial_number
string
Registry serial number
Example:
5570-246363874-246363878-VCU-024-MER-PE-14-985-08082013-07082014-1
carbon_inventory
project
Object
id
string
name
string
description
string
account
Object
id
string
name
string
description
string
beneficiary
Object
id
string
name
string
description
string
certifcations
Array
Object
id
string
guid of additional certifications
name
string
Example:
CCB-Gold
reason
Object
id
string
name
string
description
string
registry
Array
Object
id
string
Enumeration:
VERRA
IHS_MARKIT
name
string
Verra
certificate_address
string
financials
units
number
Kilogram Units to support Fractional
campaign
Object
id
string
name
string
paging
Object
page_number
integer
Example:
1
page_size
integer
Example:
10
total_elements
integer
Example:
4
total_pages
integer
Example:
1
Example 1
GET /retirements HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "69de6a72-2797-11ed-b110-42010a9a0008",
"retirement_date": 1,
"serial_number": "5570-246363874-246363878-VCU-024-MER-PE-14-985-08082013-07082014-1",
"carbon_inventory": {
"id": "",
"name": "",
"vintage": {
"vintage": "2014 - 2016",
"vintage_from": 1,
"vintage_to": 1
},
"unit_type": "VCU",
"purchase_date": 1,
"costs": {
"purchase_price": 1,
"currency": "USD"
},
"blocks": 1,
"serial_number": "",
"supplier": {
"id": "",
"name": ""
},
"verifier_reference": ""
},
"project": {
"id": "",
"name": "",
"description": ""
},
"account": {
"id": "",
"name": "",
"description": ""
},
"beneficiary": {
"id": "",
"name": "",
"description": ""
},
"certifcations": [
{
"id": "",
"name": "CCB-Gold"
}
],
"reason": {
"id": "",
"name": "",
"description": ""
},
"registry": [
{
"id": "VERRA",
"name": ""
}
],
"financials": [
{
"id": "",
"financial_type": "COST",
"wallet": 154.5,
"amount": 15.45,
"is_conversion": true,
"currency_code": "",
"rate": 144.5
}
]
}
],
"paging": {
"page_number": 1,
"page_size": 10
},
"total_elements": 4,
"total_pages": 1
}
POST
/retirements
Gets a list of retirements recorded in MC dbms and the certificates from the IHS or VERA registry
Request body
Object
id
string
Optional ID if not provided a system generated ID will be created
retirement_date
integer
Example:
1
serial_number
string
Example:
5570-246363874-246363878-VCU-024-MER-PE-14-985-08082013-07082014-1
carbon_inventory
Object
id
string
project
Object
id
string
account
Object
id
string
beneficiary
Object
id
string
reason
Object
id
string
registry
Array
Object
id
string
Example:
VERRA
certificate_url
string
financials
Array
Object
id
string
financial_type
string
Example:
COST
wallet
number
Example:
154.5
amount
number
Example:
15.45
is_conversion
boolean
Example:
true
currency_code
string
rate
number
Example:
144.5
units
number
GET
/collections
GET
/collections/id/
GET
/collections/
{id}/products
GET
/collections/
{id}/templates
GET
/collections/
{id}/schemas
GET
/schema/
{id}/attributes
GET
/collections
Responses
200
OK
Body
Examples
[
{
"id": "",
"display_name": "",
"name": "",
"description": "",
"market_fee": 1
}
]
GET
/collections/id/
Responses
200
OK
Body
Examples
{
"id": "",
"name": "",
"description": "",
"long_description": "",
"market_fee": 1,
"display_name": "",
"website_url": "",
"socials": {
"facebook_url": "",
"twitter_url": "",
"medium_url": "",
"github_url": "",
"discord_url": "",
"telegram_url": "",
"youtube_url": ""
},
"taxon": "",
"image": {
"id": "string",
"type": "LOGO",
"width": 1,
"height": 1,
"format": "string",
"url": "string",
"thumbnailUrl": "string",
"publicId": "string",
"media": [
{
"width": 1,
"height": 1,
"url": "string"
}
]
},
"video": {
"id": "string",
"type": "LOGO",
"width": 1,
"height": 1,
"format": "string",
"url": "string",
"thumbnailUrl": "string",
"publicId": "string",
"media": [
{
"width": 1,
"height": 1,
"url": "string"
}
]
},
"background_image": {
"id": "string",
"type": "LOGO",
"width": 1,
"height": 1,
"format": "string",
"url": "string",
"thumbnailUrl": "string",
"publicId": "string",
"media": [
{
"width": 1,
"height": 1,
"url": "string"
}
]
},
"integration": {
"id": "",
"name": "",
"icon": {
"active": "",
"in-active": ""
}
}
}
GET
/collections/
{id}/productsGet a list of the links to a collection product and linked creature
Path variables
id
string
required
Responses
200
200
OK
Body
Object
content
Array
Object
id
string
Example:
e28afa4d-c18b-11ec-a97e-42010a9a0008
name
string
Example:
Island Innovation NFT
description
string
Example:
There are 10,000 Island Innovation Impact NFTs and each represents 1 seedling being planted by Fundacion Groupo Social. 70% of the money is spent buying and planting seedlings, 15% supports Island Innovation and 15% supports Meta Carbon Inc.
creatives
Array
Object
id
string
Example:
0e02f4ab-797c-405c-8bf7-14651e28fe05
usage_type
unknown
width
integer
Example:
259
format
string
Example:
jpg
media_id
unknown
media
Array
Object
width
integer
Example:
50
height
integer
Example:
37
url
string
Example:
https://res.cloudinary.com/image/upload/c_scale,f_auto,q_auto,w_50/v1/bg/v6z5d9dq7wktaqmm5nbm.jpg
url
string
Example:
https://res.cloudinary.com/vizulink-tech-lmimited/image/upload/v1/bg/v6z5d9dq7wktaqmm5nbm.jpg
height
integer
Example:
194
media_group_id
unknown
public_id
string
Example:
bg/v6z5d9dq7wktaqmm5nbm
features
Array
Object
id
string
name
string
description
string
long_description
string
pricing
Array
Object
id
string
Example:
95ac16e3-c194-11ec-a97e-42010a9a0008
name
string
Example:
Island Innovation NFT
prices
Array
Object
id
string
Example:
38186aea-c18d-11ec-a97e-42010a9a0008
name
string
Example:
II-NFT-BASE
location_code
string
Example:
UK
currency
string
Example:
USD
display_price
string
Example:
$40.00
effective_date
integer
Example:
1650557281
during_binding
boolean
price
integer
Example:
40
tax_model
string
Example:
INCLUSIVE
payment_model
string
Example:
PREPAY
price_model
string
Example:
FLAT
price_type
string
Example:
ONE_OFF
primary
boolean
variants
Array
Object
id
string
Example:
817458ec-342d-11ed-adf6-42010a9a000c
sku
string
Example:
II-NFT-01-MALE
attributes
Array
Object
id
string
Example:
d87f46b4-342e-11ed-adf6-42010a9a000c
variant_map
Object
id
string
Example:
dc79ce11-342a-11ed-adf6-42010a9a000c
name
string
Example:
Background
variant_value
string
Example:
Snow Forest
pricing
Object
id
string
Example:
6d31ffe3-342e-11ed-adf6-42010a9a000c
name
string
Example:
Island Innovation NFT
prices
Array
of
unknown
payment_model
string
Example:
PREPAY
price_model
string
Example:
FLAT
price_type
string
Example:
ONE_OFF
primary
boolean
paging
Object
page_number
integer
page_size
integer
Example:
10
total_elements
integer
Example:
7
total_pages
integer
Example:
1
GET
/collections/
{id}/templatesList of templates with the default values
Path variables
id
string
required
Responses
200
default
default response
Body
Object
id
string
Example:
637991
name
string
Example:
Mountain Gorilla - Bronze
description
string
Example:
Mountain gorillas live at high elevation over 8,000 feet in the mountains of the Congo, Rwanda and Uganda. Their thick fur helps keep them warm in temperatures which often drop below freezing. Despite these conditions, Mountain Gorillas have fought extinction and recently their numbers have even increased but now, a new challenge awaits. The Mountain Gorilla is in danger and needs your help! Offset more carbon to support the Gorilla and other endangered creatures.
is_transferable
boolean
Example:
true
is_burnable
boolean
Example:
true
max_supply
integer
issued_supply
integer
Example:
94
image
Object
id
unknown
nullable
type
string
Example:
PHOTO
width
unknown
nullable
height
unknown
nullable
format
string
Example:
IPFS
url
string
Example:
https://ipfs.io/ipfs/QmUw4ZXmvGyEbyv1r5m3wsLtbrmKx6npKuY6sSmViwbcnp
thumbnail_url
unknown
nullable
public_id
string
Example:
QmUw4ZXmvGyEbyv1r5m3wsLtbrmKx6npKuY6sSmViwbcnp
media
Array
Object
width
integer
height
integer
url
string
Example:
https://ipfs.io/ipfs/QmUw4ZXmvGyEbyv1r5m3wsLtbrmKx6npKuY6sSmViwbcnp
created_on
unknown
nullable
media_external_id
unknown
nullable
media_group_external_id
unknown
nullable
video
unknown
nullable
back_image
unknown
nullable
back_video
unknown
nullable
Examples
{
"id": "637991",
"name": "Mountain Gorilla - Bronze",
"description": "Mountain gorillas live at high elevation over 8,000 feet in the mountains of the Congo, Rwanda and Uganda. Their thick fur helps keep them warm in temperatures which often drop below freezing. Despite these conditions, Mountain Gorillas have fought extinction and recently their numbers have even increased but now, a new challenge awaits. The Mountain Gorilla is in danger and needs your help! Offset more carbon to support the Gorilla and other endangered creatures. ",
"is_transferable": true,
"is_burnable": true,
"max_supply": 1,
"issued_supply": 94,
"image": {
"id": null,
"type": "PHOTO",
"width": null,
"height": null,
"format": "IPFS",
"url": "https://ipfs.io/ipfs/QmUw4ZXmvGyEbyv1r5m3wsLtbrmKx6npKuY6sSmViwbcnp",
"thumbnail_url": null,
"public_id": "QmUw4ZXmvGyEbyv1r5m3wsLtbrmKx6npKuY6sSmViwbcnp",
"media": [
{
"width": 1,
"height": 1,
"url": "https://ipfs.io/ipfs/QmUw4ZXmvGyEbyv1r5m3wsLtbrmKx6npKuY6sSmViwbcnp"
}
],
"created_on": null,
"media_external_id": null,
"media_group_external_id": null
},
"video": null,
"back_image": null,
"back_video": null
}
GET
/collections/
{id}/schemasGet a list of schema’s for a given collection
Path variables
id
string
required
Request body
GET
/schema/
{id}/attributesPath variables
id
string
required
Responses
200
OK
Body
Array
Object
id
string
name
string
Name of Atttribute
Example:
CO2 Offset Amount (kg)
lexicon
string
Lexicon to match / replace from an event body
Example:
nft.carbon.co2_offset
attribute_type
string
Type of atribute simplifed
Enumeration:
STRING
NUMBER
URI
IPFS
Examples
[
{
"id": "",
"name": "CO2 Offset Amount (kg)",
"lexicon": "nft.carbon.co2_offset",
"attribute_type": "URI"
}
]
POST
/contacts
GET
/contacts/
{id}/wallets
GET
/contacts/
{id}/nfts
POST
/wallets/
{id}/transactions
POST
/transactions
POST
/projects/
{id}/wallets
POST
/supporters
GET
/wallets/
{id}/projects
GET
/contacts/
{id}/projects
POST
/wallets/
{id}/transactionsPath variables
id
string
required
Request body
Object
transaction_date
number
date of transaction
reference
string
reference number
base_currency
Object
currency
string
Example:
USD
amount
string
Example:
1234.56
source_currency
Object
currency
string
Example:
WAXP
amount
number
carbon
Object
units
number
Kilogram Units of Carbon
POST
/transactions
Request body
Array
Object
transaction_date
integer
Example:
1
reference
string
base_currency
Object
currency
string
Example:
WAXP
amount
string
Example:
112
source_currency
Object
currency
string
Example:
USD
amount
integer
Example:
1
wallet
Object
wallet_address
string
id
string
carbon
Object
units
number
Example 1
POST /transactions HTTP/1.1
Content-Type: application/json
{
"transaction_date": 1,
"reference": "",
"base_currency": {
"currency": "USD",
"amount": "1234.56"
},
"source_currency": {
"currency": "WAXP",
"amount": 1
},
"wallet": {
"wallet_address": "",
"id": ""
},
"contact": {
"id": ""
}
}
POST
/projects/
{id}/walletsPath variables
id
string
required
Request body
Array
Object
wallet
Object
id
string
Wallet ID if internal
wallet_address
string
Wallet address wil be used for lookup
wallet_role
string
Enumeration:
SUPPORTER
FUNDING
REVENUE
Example 1
POST /projects/{id}/wallets HTTP/1.1
Content-Type: application/json
[
{
"wallet": {
"id": "",
"wallet_address": ""
},
"priority": "",
"wallet_role": "REVENUE"
}
]
GET
/contacts/
{id}/projectsList of Wallets connected to a Projects, to use for fund distribution, and tracking
Path variables
id
string
required
Responses
200
OK
Body
Array
Object
project
Object
id
string
name
string
description
string
wallet
Object
id
string
address
string
wallet_role
string
NFT are created based on a Product in the case of merchandising, or simply represetn a certifiction such as a retirement certificate
GET
/nfts
GET
/nfts/
{id}
GET
/collections/
{id}/nfs
GET
/nfts/
{id}/retirements
GET
/nfts/
{id}/attributes
GET
/nfts
POST
/minting
GET
/nft/
{id}/retirement
GET
/nfts/
{id}
GET
/nfts
Request parameters
collection_id
string
optional
List of collection ID
Example:
abc123,xyz123
created
number
optional
date ranges use dot notation for different params created.from created.before
nft_type
string
optional
Type of NFT
Enumeration:
MERCHANDISE
RETIREMENT
campaign_id
string
optional
Ensure that the list of nft’s is returned in tier priority order
Responses
200
200
OK
Body
Examples
[
{
"id": "",
"name": "",
"description": "",
"nft_type": "",
"created_date": "",
"image": {
"id": "string",
"type": "LOGO",
"width": 1,
"height": 1,
"format": "string",
"url": "string",
"thumbnailUrl": "string",
"publicId": "string",
"media": [
{
"width": 1,
"height": 1,
"url": "string"
}
]
},
"video": {
"id": "string",
"type": "LOGO",
"width": 1,
"height": 1,
"format": "string",
"url": "string",
"thumbnailUrl": "string",
"publicId": "string",
"media": [
{
"width": 1,
"height": 1,
"url": "string"
}
]
},
"is_ipfs": true,
"is_fractional": true,
"is_transferable": true,
"rank": 1,
"series": {
"issue": "",
"total": ""
},
"lifecycle": "RANKED",
"campaign": {
"id": "",
"name": "",
"description": ""
},
"tier": {
"id": "",
"name": "",
"description": "",
"rank_min": "",
"rank_max": "",
"color_code": "",
"priority": 1
},
"template": {
"id": "",
"name": "",
"description": ""
},
"collection": {
"id": "",
"name": "",
"description": ""
},
"blockchains": [
{
"id": "",
"minted_date": "",
"platform": "",
"token": {
"id": "",
"token_type": ""
}
}
],
"owners": [
{
"id": "",
"wallet_id": "0x0fca20275697de6ebff30a293b3ceb21c003e972",
"organisation": {
"id": "",
"name": ""
},
"contact": {
"id": "",
"name": ""
},
"ownership_start": 1,
"ownership_end": 1,
"percentage": 100
}
]
}
]
GET
/nfts/
{id}Path variables
id
string
required
Responses
200
default
default response
Body
Object
id
string
name
string
description
string
nft_type
string
Enumeration:
MERCHANDISE
RETIREMENT
is_fractional
string
is_transferable
string
image_id
video_id
lifecycle
string
Enumeration:
RANKED
MINTED
series_number
string
total_in_series
string
is_ipfs
string
created_date
string
tier
Object
id
string
name
string
co2_offset_amount
number
retirement
Object
id
string
template
Object
id
string
name
string
collection
Object
id
string
name
string
blockchain
Object
id
string
token
string
token_type
string
platform
string
minted_date
string
owner
Array
Object
id
string
contact_id
string
organisation_id
string
given_name
string
percentage
number
ownership_start
string
ownership_end
string
wallet
Object
id
string
alias
string
wallet_address
string
tenant_id
string
Example 1
GET /nfts/{id} HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "",
"name": "",
"description": "",
"nft_type": "MERCHANDISE",
"is_fractional": "",
"is_transferable": "",
"image_id": {
"id": "string",
"type": "LOGO",
"width": 1,
"height": 1,
"format": "string",
"url": "string",
"thumbnailUrl": "string",
"publicId": "string",
"media": [
{
"width": 1,
"height": 1,
"url": "string"
}
]
},
"video_id": {
"id": "string",
"type": "LOGO",
"width": 1,
"height": 1,
"format": "string",
"url": "string",
"thumbnailUrl": "string",
"publicId": "string",
"media": [
{
"width": 1,
"height": 1,
"url": "string"
}
]
},
"lifecycle": "MINTED",
"series_number": "",
"total_in_series": "",
"is_ipfs": "",
"created_date": "",
"tier": {
"id": "",
"name": ""
},
"co2_offset_amount": 1,
"retirement": {
"id": ""
},
"template": {
"id": "",
"name": ""
},
"collection": {
"id": "",
"name": ""
},
"blockchain": {
"id": "",
"token": "",
"token_type": "",
"platform": "",
"minted_date": ""
},
"owner": [
{
"id": "",
"contact_id": "",
"organisation_id": "",
"given_name": "",
"percentage": 1,
"ownership_start": "",
"ownership_end": "",
"wallet": {
"id": "",
"alias": "",
"wallet_address": "",
"tenant_id": ""
}
}
]
}
GET
/collections/
{id}/nfsGet a list of NFT’s for a collection
Path variables
id
string
required
Request parameters
start_date
string
optional
end_date
string
optional
nf_type
string
optional
List of nft_types
Responses
200
200
OK
Body
Object
content
Array
Object
id
string
Example:
e28afa4d-c18b-11ec-a97e-42010a9a0008
name
string
Example:
Fred Island NFT
description
string
Example:
There are 10,000 Island Innovation Impact NFTs and each represents 1 seedling being planted by Fundacion Groupo Social. 70% of the money is spent buying and planting seedlings, 15% supports Island Innovation and 15% supports Meta Carbon Inc.
nft_type
string
Example:
MERCHANDISE
creatives
Array
Object
id
string
Example:
0e02f4ab-797c-405c-8bf7-14651e28fe05
usage_type
unknown
width
integer
Example:
259
format
string
Example:
jpg
media_id
string
media
Array
Object
width
integer
Example:
50
height
integer
Example:
37
url
string
Example:
https://res.cloudinary.com/image/upload/c_scale,f_auto,q_auto,w_50/v1/bg/v6z5d9dq7wktaqmm5nbm.jpg
url
string
Example:
https://res.cloudinary.com/vizulink-tech-lmimited/image/upload/v1/bg/v6z5d9dq7wktaqmm5nbm.jpg
height
integer
Example:
194
media_group_id
unknown
public_id
string
Example:
bg/v6z5d9dq7wktaqmm5nbm
product
Object
integration
Object
id
string
name
string
sku
string
id
string
name
string
Example:
Island NFT
description
string
Example:
There are 10,000 Island Innovation Impact NFTs and each represents 1 seedling being planted by Fundacion Groupo Social. 70% of the money is spent buying and planting seedlings, 15% supports Island Innovation and 15% supports Meta Carbon Inc.
sku
string
family
string
Example:
Island Innovation
brand
string
blockchain
Object
token
Object
id
string
hash
string
uri
string
platform
string
Example:
POLYGON
minted_date
string
collection
Object
id
string
name
string
owners
Array
Object
id
string
wallet_id
string
contact
Object
id
string
name
string
ownership_start
integer
Example:
1
ownwership_end
string
paging
Object
page_number
integer
Example:
1
page_size
integer
Example:
10
total_elements
integer
Example:
7
total_pages
integer
Example:
1
GET
/nfts/
{id}/attributesList of attributes for an NFT, extracted from the Product Catalog
Path variables
id
string
required
Responses
200
OK
Body
Example 1
GET /nfts/{id}/attributes HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
[
{
"id": "",
"name": "",
"description": "",
"attribute_value": "Critically Endangered",
"iso639-2": "eng"
}
]
GET
/nfts
Request parameters
collection_id
string
optional
List of collection ID
Example:
abc123,xyz123
created
number
optional
date ranges use dot notation for different params created.from created.before
nft_type
string
optional
Type of NFT
Enumeration:
MERCHANDISE
RETIREMENT
Responses
200
200
OK
Body
Object
content
Array
Object
id
string
Example:
e28afa4d-c18b-11ec-a97e-42010a9a0008
name
string
Example:
Fred Island NFT
description
string
Example:
There are 10,000 Island Innovation Impact NFTs and each represents 1 seedling being planted by Fundacion Groupo Social. 70% of the money is spent buying and planting seedlings, 15% supports Island Innovation and 15% supports Meta Carbon Inc.
nft_type
string
Type of nft Merchandise or Retirement
Enumeration:
MERCHANDISE
RETIREMENT
creatives
Array
Object
id
string
Example:
0e02f4ab-797c-405c-8bf7-14651e28fe05
usage_type
unknown
width
integer
Example:
259
format
string
Example:
jpg
media_id
string
media
Array
Object
width
integer
Example:
50
height
integer
Example:
37
url
string
Example:
https://res.cloudinary.com/image/upload/c_scale,f_auto,q_auto,w_50/v1/bg/v6z5d9dq7wktaqmm5nbm.jpg
url
string
Example:
https://res.cloudinary.com/vizulink-tech-lmimited/image/upload/v1/bg/v6z5d9dq7wktaqmm5nbm.jpg
height
integer
Example:
194
media_group_id
unknown
public_id
string
Example:
bg/v6z5d9dq7wktaqmm5nbm
product
Object
NFT originating product from catalog.
integration
Object
If the product originated from an external source such as Shopify
id
string
name
string
sku
string
id
string
guid
name
string
Original Product Name
Example:
Island NFT
description
string
Original product Description
Example:
There are 10,000 Island Innovation Impact NFTs and each represents 1 seedling being planted by Fundacion Groupo Social. 70% of the money is spent buying and planting seedlings, 15% supports Island Innovation and 15% supports Meta Carbon Inc.
sku
string
family
string
Family from product Catalog
Example:
Island Innovation
brand
string
Brand from Product Catalog
blockchain
Object
token
Object
id
string
hash
string
uri
string
platform
string
Enumeration:
POLYGON
WAX
minted_date
string
date of minting
collection
Object
id
string
name
string
owners
Array
Object
id
string
wallet_id
string
wallet
contact
Object
Contact Details Name or alias if linked
id
string
name
string
Contacts name or alias
ownership_start
number
Date ownership was assigned
ownwership_end
string
Date ownership was ended if transfered.
paging
Object
page_number
integer
Example:
1
page_size
integer
Example:
10
total_elements
integer
Example:
7
total_pages
integer
Example:
1
Example 1
GET /nfts HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "e28afa4d-c18b-11ec-a97e-42010a9a0008",
"name": "Fred Island NFT",
"description": "There are 10,000 Island Innovation Impact NFTs and each represents 1 seedling being planted by Fundacion Groupo Social. 70% of the money is spent buying and planting seedlings, 15% supports Island Innovation and 15% supports Meta Carbon Inc.",
"nft_type": "RETIREMENT",
"creatives": [
{
"id": "0e02f4ab-797c-405c-8bf7-14651e28fe05",
"usage_type": null,
"width": 259,
"format": "jpg",
"media_id": "",
"media": [
{
"width": 50,
"height": 37,
"url": "https://res.cloudinary.com/image/upload/c_scale,f_auto,q_auto,w_50/v1/bg/v6z5d9dq7wktaqmm5nbm.jpg"
}
],
"url": "https://res.cloudinary.com/vizulink-tech-lmimited/image/upload/v1/bg/v6z5d9dq7wktaqmm5nbm.jpg",
"height": 194,
"media_group_id": null,
"public_id": "bg/v6z5d9dq7wktaqmm5nbm"
}
],
"product": {
"integration": {
"id": "",
"name": "",
"sku": ""
},
"id": "",
"name": "Island NFT",
"description": "There are 10,000 Island Innovation Impact NFTs and each represents 1 seedling being planted by Fundacion Groupo Social. 70% of the money is spent buying and planting seedlings, 15% supports Island Innovation and 15% supports Meta Carbon Inc.",
"sku": "",
"family": "Island Innovation",
"brand": ""
},
"blockchain": {
"token": {
"id": "",
"hash": "",
"uri": ""
},
"platform": "WAX",
"minted_date": ""
},
"collection": {
"id": "",
"name": ""
},
"owners": [
{
"id": "",
"wallet_id": "",
"contact": {
"id": "",
"name": ""
},
"ownership_start": 1,
"ownwership_end": ""
}
]
}
],
"paging": {
"page_number": 1,
"page_size": 10
},
"total_elements": 7,
"total_pages": 1
}
GET
/nft/
{id}/retirementPath variables
id
string
required
Responses
200
OK
Body
Object
id
string
details
string
offset_url
string
co2_offset_amount
string
unit_type
string
retirement_date
string
is_pending
string
serial_number
string
project
Object
inventory
Object
id
string
serial_number
string
beneficiary
Object
id
string
name
string
account
Object
id
string
name
string
retirement_reason
Object
id
string
name
string
description
string
registry
Object
id
string
name
string
description
string
Examples
{
"id": "",
"details": "",
"offset_url": "",
"co2_offset_amount": "",
"unit_type": "",
"retirement_date": "",
"is_pending": "",
"serial_number": "",
"project": {
"id": "",
"name": "",
"image": {
"id": "string",
"type": "LOGO",
"width": 1,
"height": 1,
"format": "string",
"url": "string",
"thumbnailUrl": "string",
"publicId": "string",
"media": [
{
"width": 1,
"height": 1,
"url": "string"
}
]
}
},
"inventory": {
"id": "",
"serial_number": ""
},
"beneficiary": {
"id": "",
"name": ""
},
"account": {
"id": "",
"name": ""
},
"retirement_reason": {
"id": "",
"name": "",
"description": ""
},
"registry": {
"id": "",
"name": "",
"description": ""
}
}
GET
/nfts/
{id}Path variables
id
string
required
Responses
200
default
default response
Body
Object
id
string
Example:
dc7ac2af-d65f-4261-832b-e08193b354d2
name
string
Example:
Elephant Bronze
description
string
Example:
Elephant Bronze: Atomic Hub Feb 2023
nft_type
string
Example:
MERCHANDISE
image
Object
id
unknown
nullable
type
string
Example:
PHOTO
width
unknown
nullable
height
unknown
nullable
format
string
Example:
IPFS
url
string
Example:
https://ipfs.io/ipfs/Qmd9ZGZXPLW2GortTYAAMNB4wJJn8Ypt1ZWrv175qhBcGN
thumbnail_url
unknown
nullable
public_id
string
Example:
Qmd9ZGZXPLW2GortTYAAMNB4wJJn8Ypt1ZWrv175qhBcGN
media
Array
Object
width
integer
height
integer
url
string
Example:
https://ipfs.io/ipfs/Qmd9ZGZXPLW2GortTYAAMNB4wJJn8Ypt1ZWrv175qhBcGN
created_on
unknown
nullable
media_external_id
unknown
nullable
media_group_external_id
unknown
nullable
video
unknown
nullable
collection
Object
id
string
Example:
c582e699-3a6a-11ed-adf6-42010a9a000c
name
string
Example:
Meta Carbon Offset
owner
Object
id
string
Example:
1d3f9cc6-70c7-42f3-919d-5e0faf3c860f
wallet
Object
id
string
Example:
1e5af15c-dd93-405d-b21a-50b29cda0da5
alias
unknown
nullable
wallet_address
string
Example:
k.ovq.wam
organisation
Object
id
unknown
nullable
name
unknown
nullable
contact
Object
id
unknown
nullable
name
unknown
nullable
ownwership_end
integer
ownership_start
integer
Example:
1678122335
series
Object
issue
integer
Example:
34
total
integer
rank
integer
Rank from NFT
lifecycle
string
Example:
MINTED
tier
Object
id
string
Example:
bde672f3-76d2-11ed-a040-42010a9a0003
name
string
Example:
Bronze
color_code
string
Example:
#D2C7C7
blockchain
Array
Object
id
string
Example:
d0f0278c-3915-418c-9295-f59e5153ced0
token
Object
id
string
Example:
1099552529997
token_type
string
Example:
WAX
platform
string
Example:
WAX
minted_date
integer
Example:
1678122380
carbon
Array
Object
id
string
Example:
f76b05fa-1d6e-4040-a3c3-87e636b83cf1
retirement_date
string
Example:
2023-03-06T17:02:55Z
serial_number
string
Example:
12787-437759053-437759075-VCS-VCU-259-VER-CD-14-934-01012017-31122017-1
carbon_inventory
Object
id
string
Example:
9d8e3ad7-65c3-11ed-885d-42010a9a0002
vintage
Object
name
string
Example:
2017
vintage_from
string
Example:
2017
vintage_to
string
Example:
2017
unit_type
unknown
nullable
purchase_date
integer
Example:
1667520000
carbon
Object
open_balance
integer
Example:
5000
current_balance
integer
Example:
5000
serial_number
string
Example:
12787-437519438-437524437-VCS-VCU-259-VER-CD-14-934-01012017-31122017-1
supplier
Object
id
string
Example:
0a1029ba-65c1-11ed-885d-42010a9a0002
consigned
Object
verifier_reference
unknown
nullable
registry
Object
id
string
Example:
36ca5da6-6c0b-11ed-aec0-42010a9a0004
name
string
Example:
VERRA
account
Object
name
string
Example:
Meta Carbon
id
string
Example:
841d528d-3112-11ed-adf6-42010a9a000c
beneficiary
Object
name
string
Example:
Atomic Hub
id
string
Example:
87ed427e-3a64-11ed-adf6-42010a9a000c
certifications
unknown
nullable
reason
Object
id
string
Example:
ec502490-3f14-11ed-adf6-42010a9a000a
name
string
Example:
Carbon Offset
description
string
Example:
Carbon Offset
registry
Object
id
string
Example:
36ca5da6-6c0b-11ed-aec0-42010a9a0004
name
string
Example:
VERRA
unit_type
string
Example:
VCU
project
Object
id
string
Example:
6015c543-4ed8-11ed-aec0-42010a9a0004
name
string
Example:
Mai Ndombe
description
string
Example:
Help this project protect over 250,000 hectares of critical bonobo and forest elephant habitat and provide drinking water, education, healthcare, and food security to 30,000 locals.
financials
Array
of
unknown
offset_url
string
Example:
https://registry.verra.org/myModule/rpt/myrpt.asp?r=206&h=190672
units
integer
Example:
1000
merchandise
Object
units
integer
Example:
1
Example 1
GET /nfts/{id} HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "dc7ac2af-d65f-4261-832b-e08193b354d2",
"name": "Elephant Bronze",
"description": "Elephant Bronze: Atomic Hub Feb 2023",
"nft_type": "MERCHANDISE",
"image": {
"id": null,
"type": "PHOTO",
"width": null,
"height": null,
"format": "IPFS",
"url": "https://ipfs.io/ipfs/Qmd9ZGZXPLW2GortTYAAMNB4wJJn8Ypt1ZWrv175qhBcGN",
"thumbnail_url": null,
"public_id": "Qmd9ZGZXPLW2GortTYAAMNB4wJJn8Ypt1ZWrv175qhBcGN",
"media": [
{
"width": 1,
"height": 1,
"url": "https://ipfs.io/ipfs/Qmd9ZGZXPLW2GortTYAAMNB4wJJn8Ypt1ZWrv175qhBcGN"
}
],
"created_on": null,
"media_external_id": null,
"media_group_external_id": null
},
"video": null,
"collection": {
"id": "c582e699-3a6a-11ed-adf6-42010a9a000c",
"name": "Meta Carbon Offset"
},
"owner": {
"id": "1d3f9cc6-70c7-42f3-919d-5e0faf3c860f",
"wallet": {
"id": "1e5af15c-dd93-405d-b21a-50b29cda0da5",
"alias": null,
"wallet_address": "k.ovq.wam"
},
"organisation": {
"id": null,
"name": null
},
"contact": {
"id": null,
"name": null
},
"ownwership_end": 1,
"ownership_start": 1678122335
},
"series": {
"issue": 34,
"total": 1,
"rank": 1
},
"lifecycle": "MINTED",
"tier": {
"id": "bde672f3-76d2-11ed-a040-42010a9a0003",
"name": "Bronze",
"color_code": "#D2C7C7"
},
"blockchain": [
{
"id": "d0f0278c-3915-418c-9295-f59e5153ced0",
"token": {
"id": "1099552529997",
"token_type": "WAX"
},
"platform": "WAX",
"minted_date": 1678122380
}
],
"carbon": [
{
"id": "f76b05fa-1d6e-4040-a3c3-87e636b83cf1",
"retirement_date": "2023-03-06T17:02:55Z",
"serial_number": "12787-437759053-437759075-VCS-VCU-259-VER-CD-14-934-01012017-31122017-1",
"carbon_inventory": {
"id": "9d8e3ad7-65c3-11ed-885d-42010a9a0002",
"vintage": {
"name": "2017",
"vintage_from": "2017",
"vintage_to": "2017"
},
"unit_type": null,
"purchase_date": 1667520000,
"carbon": {
"open_balance": 5000,
"current_balance": 5000
},
"serial_number": "12787-437519438-437524437-VCS-VCU-259-VER-CD-14-934-01012017-31122017-1",
"supplier": {
"id": "0a1029ba-65c1-11ed-885d-42010a9a0002"
},
"consigned": {},
"verifier_reference": null,
"registry": {
"id": "36ca5da6-6c0b-11ed-aec0-42010a9a0004",
"name": "VERRA"
}
},
"account": {
"name": "Meta Carbon",
"id": "841d528d-3112-11ed-adf6-42010a9a000c"
},
"beneficiary": {
"name": "Atomic Hub",
"id": "87ed427e-3a64-11ed-adf6-42010a9a000c"
},
"certifications": null,
"reason": {
"id": "ec502490-3f14-11ed-adf6-42010a9a000a",
"name": "Carbon Offset",
"description": "Carbon Offset"
},
"registry": {
"id": "36ca5da6-6c0b-11ed-aec0-42010a9a0004",
"name": "VERRA"
},
"unit_type": "VCU",
"project": {
"id": "6015c543-4ed8-11ed-aec0-42010a9a0004",
"name": "Mai Ndombe",
"description": "Help this project protect over 250,000 hectares of critical bonobo and forest elephant habitat and provide drinking water, education, healthcare, and food security to 30,000 locals."
},
"financials": [
null
],
"offset_url": "https://registry.verra.org/myModule/rpt/myrpt.asp?r=206&h=190672",
"units": 1000,
"merchandise": {
"units": 1
}
}
]
}Rules for merchandiding to support ranking etc
GET
/tiers
GET
/template_rules
GET
/template_rules
Request parameters
project_id
string
optional
template_id
string
optional
Meta-carbon supports its own Product Catlog to allow Digital Goods such as NFT’s like a creature to be specified inlcuding all the variants and prices. These Products can then be used to apply attributes to an NFT, Creature Type, Colour, Gender, Endangered status.
If required then third party catalogs can be used, suc h as Shopify or other eCommerce platforms.
GET
/products
GET
/products
Request parameters
brand_id
string
optional
family_id
string
optional
product_type_id
string
optional
Type of Products
Responses
200
200
OK
Body
Object
content
Array
Object
id
string
Example:
e28afa4d-c18b-11ec-a97e-42010a9a0008
created_on
integer
Example:
1650556708
name
string
Example:
Island Innovation NFT
description
string
Example:
There are 10,000 Island Innovation Impact NFTs and each represents 1 seedling being planted by Fundacion Groupo Social. 70% of the money is spent buying and planting seedlings, 15% supports Island Innovation and 15% supports Meta Carbon Inc.
business_type
string
Example:
NFT
product_type
string
Example:
NFT
product_class
string
Example:
DIGITAL
sold_as
string
Example:
SERIES
tenant_id
string
Example:
0eafff17-c290-44ed-8556-f142533fb251
sku
string
Example:
II-NFT-01
series_count
integer
Example:
10000
families
Array
Object
id
string
Example:
18b13e22-c18c-11ec-a97e-42010a9a0008
name
string
Example:
Island Innovation
description
string
Example:
Connecting Islands for Positive Change
brands
Array
Object
id
string
Example:
8ae09b0c-c18c-11ec-a97e-42010a9a0008
name
string
Example:
Island Innovation
description
string
Example:
Island Innovation
pricing
Array
Object
id
string
Example:
95ac16e3-c194-11ec-a97e-42010a9a0008
name
string
Example:
Island Innovation NFT
prices
Array
Object
id
string
Example:
38186aea-c18d-11ec-a97e-42010a9a0008
name
string
Example:
II-NFT-BASE
location_code
string
Example:
UK
currency
string
Example:
USD
display_price
string
Example:
$40.00
effective_date
integer
Example:
1650557281
during_binding
boolean
price
integer
Example:
40
tax_model
string
Example:
INCLUSIVE
payment_model
string
Example:
PREPAY
price_model
string
Example:
FLAT
price_type
string
Example:
ONE_OFF
primary
boolean
features
Array
Object
id
string
name
string
description
string
long_description
string
creatives
Array
Object
id
string
Example:
0e02f4ab-797c-405c-8bf7-14651e28fe05
usage_type
unknown
width
integer
Example:
259
format
string
Example:
jpg
media_id
string
media
Array
Object
width
integer
Example:
50
height
integer
Example:
37
url
string
Example:
https://res.cloudinary.com/image/upload/c_scale,f_auto,q_auto,w_50/v1/bg/v6z5d9dq7wktaqmm5nbm.jpg
url
string
Example:
https://res.cloudinary.com/vizulink-tech-lmimited/image/upload/v1/bg/v6z5d9dq7wktaqmm5nbm.jpg
height
integer
Example:
194
media_group_id
unknown
public_id
string
Example:
bg/v6z5d9dq7wktaqmm5nbm
paging
Object
page_number
integer
page_size
integer
Example:
10
total_elements
integer
Example:
7
total_pages
integer
Example:
1
Example 1
GET /products HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"content": [
{
"id": "e28afa4d-c18b-11ec-a97e-42010a9a0008",
"created_on": 1650556708,
"name": "Island Innovation NFT",
"description": "There are 10,000 Island Innovation Impact NFTs and each represents 1 seedling being planted by Fundacion Groupo Social. 70% of the money is spent buying and planting seedlings, 15% supports Island Innovation and 15% supports Meta Carbon Inc.",
"business_type": "NFT",
"product_type": "NFT",
"product_class": "DIGITAL",
"sold_as": "SERIES",
"tenant_id": "0eafff17-c290-44ed-8556-f142533fb251",
"sku": "II-NFT-01",
"series_count": 10000,
"families": [
{
"id": "18b13e22-c18c-11ec-a97e-42010a9a0008",
"name": "Island Innovation",
"description": "Connecting Islands for Positive Change"
}
],
"brands": [
{
"id": "8ae09b0c-c18c-11ec-a97e-42010a9a0008",
"name": "Island Innovation",
"description": "Island Innovation"
}
],
"pricing": [
{
"id": "95ac16e3-c194-11ec-a97e-42010a9a0008",
"name": "Island Innovation NFT",
"prices": [
{
"id": "38186aea-c18d-11ec-a97e-42010a9a0008",
"name": "II-NFT-BASE",
"location_code": "UK",
"currency": "USD",
"display_price": "$40.00",
"effective_date": 1650557281,
"during_binding": true,
"price": 40,
"tax_model": "INCLUSIVE"
}
],
"payment_model": "PREPAY",
"price_model": "FLAT",
"price_type": "ONE_OFF",
"primary": true
}
],
"features": [
null
],
"filters": [
null
],
"creatives": [
{
"id": "0e02f4ab-797c-405c-8bf7-14651e28fe05",
"usage_type": null,
"width": 259,
"format": "jpg",
"media_id": null,
"media": [
{
"width": 50,
"height": 37,
"url": "https://res.cloudinary.com/image/upload/c_scale,f_auto,q_auto,w_50/v1/bg/v6z5d9dq7wktaqmm5nbm.jpg"
}
],
"url": "https://res.cloudinary.com/vizulink-tech-lmimited/image/upload/v1/bg/v6z5d9dq7wktaqmm5nbm.jpg",
"height": 194,
"media_group": {
"id": "",
"name": ""
},
"public_id": "bg/v6z5d9dq7wktaqmm5nbm"
}
]
}
],
"paging": {
"page_number": 1,
"page_size": 10
},
"total_elements": 7,
"total_pages": 1
}
Array
Object
id
string
name
string
description
string
attributes
Array
Object
id
string
attribute_name
string
attribute_type
string
lexicon
string
Example 1
[
{
"id": "",
"name": "",
"description": "",
"attributes": [
{
"id": "",
"attribute_name": "",
"attribute_type": "",
"lexicon": ""
}
]
}
]Example 1
{
"id": "",
"name": "CO2 Offset Amount (kg)",
"lexicon": "nft.carbon.co2_offset",
"attribute_type": "URI"
}
Object
id
string
Example:
string
retirement_date
string
Example:
string
serial_number
string
Example:
string
inventory
Object
id
string
Example:
string
vintage
Object
name
string
Example:
string
vintage_from
string
Example:
string
vintage_to
string
Example:
string
unit_type
string
Example:
string
carbon
Object
open_balance
integer
current_balance
integer
costs
Object
purchase_price
integer
currency
string
Example:
string
purchase_date
string
serial_number
string
Example:
string
supplier
Object
id
string
Example:
string
name
string
Example:
string
consigned
Object
id
string
Example:
string
name
string
Example:
string
verifier_reference
string
Example:
string
blocks
integer
registry
Object
id
string
Example:
string
name
string
Example:
string
project
Object
id
string
name
string
account
Object
id
string
Example:
string
name
string
Example:
string
beneficiary
Object
id
string
Example:
string
name
string
Example:
string
certifications
Object
id
string
Example:
string
name
string
Example:
string
reason
Object
id
string
Example:
string
name
string
Example:
string
registry
Object
id
string
Example:
string
name
string
Example:
string
blocks
Object
units
string
unit_type
string
offset_url
string
Example:
string
Object
id
string
Example:
string
retirement_date
string
Example:
string
serial_number
string
Example:
string
inventory
Object
id
string
Example:
string
project
Object
id
string
name
string
account
Object
id
string
Example:
string
name
string
Example:
string
beneficiary
Object
id
string
Example:
string
name
string
Example:
string
registry
Object
id
string
Example:
string
name
string
Example:
string
blocks
Object
units
string
unit_type
string
offset_url
string
Example:
string
Example 1
[
{
"id": "",
"name": "",
"description": "",
"is_transferable": true,
"is_burnable": true,
"max_supply": 1,
"image": {
"id": "string",
"type": "LOGO",
"width": 1,
"height": 1,
"format": "string",
"url": "string",
"thumbnailUrl": "string",
"publicId": "string",
"media": [
{
"width": 1,
"height": 1,
"url": "string"
}
]
},
"video": {
"id": "string",
"type": "LOGO",
"width": 1,
"height": 1,
"format": "string",
"url": "string",
"thumbnailUrl": "string",
"publicId": "string",
"media": [
{
"width": 1,
"height": 1,
"url": "string"
}
]
},
"back_image": {
"id": "string",
"type": "LOGO",
"width": 1,
"height": 1,
"format": "string",
"url": "string",
"thumbnailUrl": "string",
"publicId": "string",
"media": [
{
"width": 1,
"height": 1,
"url": "string"
}
]
},
"back_video": {
"id": "string",
"type": "LOGO",
"width": 1,
"height": 1,
"format": "string",
"url": "string",
"thumbnailUrl": "string",
"publicId": "string",
"media": [
{
"width": 1,
"height": 1,
"url": "string"
}
]
},
"issued_supply": 1,
"is_ipfs": true,
"schema": {
"id": "",
"name": ""
}
}
]Example 1
{
"id": "",
"name": "",
"description": "",
"is_transferable": true,
"is_burnable": "",
"max_supply": 1,
"image": {
"id": "string",
"type": "LOGO",
"width": 1,
"height": 1,
"format": "string",
"url": "string",
"thumbnailUrl": "string",
"publicId": "string",
"media": [
{
"width": 1,
"height": 1,
"url": "string"
}
]
},
"back_image": {
"id": "string",
"type": "LOGO",
"width": 1,
"height": 1,
"format": "string",
"url": "string",
"thumbnailUrl": "string",
"publicId": "string",
"media": [
{
"width": 1,
"height": 1,
"url": "string"
}
]
},
"video": {
"id": "string",
"type": "LOGO",
"width": 1,
"height": 1,
"format": "string",
"url": "string",
"thumbnailUrl": "string",
"publicId": "string",
"media": [
{
"width": 1,
"height": 1,
"url": "string"
}
]
},
"back_video": {
"id": "string",
"type": "LOGO",
"width": 1,
"height": 1,
"format": "string",
"url": "string",
"thumbnailUrl": "string",
"publicId": "string",
"media": [
{
"width": 1,
"height": 1,
"url": "string"
}
]
},
"issued_supply": "",
"schema_id": {
"id": "",
"name": "",
"description": ""
},
"is_ipfs": true
}
Object
id
string
name
string
description
string
rank
Object
min
string
max
string
colour_code
string
template
Object
id
string
name
string
priority
number
Object
id
string
Example:
e28afa4d-c18b-11ec-a97e-42010a9a0008
name
string
Example:
Fred Island NFT
description
string
Example:
There are 10,000 Island Innovation Impact NFTs and each represents 1 seedling being planted by Fundacion Groupo Social. 70% of the money is spent buying and planting seedlings, 15% supports Island Innovation and 15% supports Meta Carbon Inc.
nft_type
string
Example:
RETIREMENT
image
video
blockchain
Array
Object
token
Object
id
string
hash
string
uri
string
token_type
string
Example:
ERC721
platform
string
Example:
POLYGON
minted_date
string
collection
Object
id
string
name
string
owners
Array
Object
id
string
wallet_id
string
Example:
0x0fca20275697de6ebff30a293b3ceb21c003e972
organisation
Object
id
string
name
string
contact
Object
id
string
name
string
ownership_start
integer
Example:
1
ownership_end
integer
Example:
1
percentage
integer
Example:
100
series
Object
issue
integer
Example:
232
total
integer
Example:
500
organisations
Array
Object
id
string
name
string
organisation_role
string
Enumeration:
ENVIRONMENTAL_BENIFICIARY
SPONSOR
Example 1
{
"id": "e28afa4d-c18b-11ec-a97e-42010a9a0008",
"name": "Fred Island NFT",
"description": "There are 10,000 Island Innovation Impact NFTs and each represents 1 seedling being planted by Fundacion Groupo Social. 70% of the money is spent buying and planting seedlings, 15% supports Island Innovation and 15% supports Meta Carbon Inc.",
"nft_type": "RETIREMENT",
"image": {
"id": "0e02f4ab-797c-405c-8bf7-14651e28fe05",
"usage_type": null,
"width": 259,
"format": "jpg",
"media_id": null,
"media": [
{
"width": 50,
"height": 37,
"url": "https://res.cloudinary.com/image/upload/c_scale,f_auto,q_auto,w_50/v1/bg/v6z5d9dq7wktaqmm5nbm.jpg"
}
],
"url": "https://res.cloudinary.com/vizulink-tech-lmimited/image/upload/v1/bg/v6z5d9dq7wktaqmm5nbm.jpg",
"height": 194,
"media_group": {
"id": "",
"name": ""
},
"public_id": "bg/v6z5d9dq7wktaqmm5nbm"
},
"video": {
"id": "0e02f4ab-797c-405c-8bf7-14651e28fe05",
"usage_type": null,
"width": 259,
"format": "jpg",
"media_id": null,
"media": [
{
"width": 50,
"height": 37,
"url": "https://res.cloudinary.com/image/upload/c_scale,f_auto,q_auto,w_50/v1/bg/v6z5d9dq7wktaqmm5nbm.jpg"
}
],
"url": "https://res.cloudinary.com/vizulink-tech-lmimited/image/upload/v1/bg/v6z5d9dq7wktaqmm5nbm.jpg",
"height": 194,
"media_group": {
"id": "",
"name": ""
},
"public_id": "bg/v6z5d9dq7wktaqmm5nbm"
},
"blockchain": [
{
"token": {
"id": "",
"hash": "",
"uri": "",
"token_type": "ERC721"
},
"platform": "POLYGON",
"minted_date": ""
}
],
"collection": {
"id": "",
"name": ""
},
"owners": [
{
"id": "",
"wallet_id": "0x0fca20275697de6ebff30a293b3ceb21c003e972",
"organisation": {
"id": "",
"name": ""
},
"contact": {
"id": "",
"name": ""
},
"ownership_start": 1,
"ownership_end": 1,
"percentage": 100
}
],
"series": {
"issue": 232,
"total": 500
},
"organisations": [
{
"id": "",
"name": "",
"organisation_role": "SPONSOR"
}
],
"project": {
"id": "",
"name": "",
"description": "",
"location": {
"geo": {
"lat": 15.638126,
"lon": -88.822659
},
"continent": "Africa",
"country": "Sierra Leone",
"region": "",
"iso_": ""
},
"sdg_goals": [
{
"id": "",
"sdg_goal": 1,
"name": "",
"description": ""
}
],
"creatures": [
{
"id": "",
"name": "",
"description": "",
"iucn_status": "EXTINCT",
"iucn_url": ""
}
]
}
}NFT lsit itm, used for lists, search filters
Array
Object
id
string
name
string
description
string
nft_type
string
created_date
string
image
video
is_ipfs
boolean
is_fractional
boolean
is_transferable
boolean
rank
number
series
Object
issue
string
total
string
lifecycle
string
Enumeration:
RANKED
MINTED
PENDING
QUEUED
campaign
Object
id
string
name
string
description
string
tier
Object
id
string
name
string
description
string
rank_min
string
rank_max
string
color_code
string
priority
number
template
Object
id
string
name
string
description
string
collection
Object
id
string
name
string
description
string
blockchains
Array
Object
id
string
minted_date
string
platform
string
token
Object
id
string
token_type
string
owners
Array
Ensure the latest owner based on date is object 0
Object
id
string
wallet_id
string
Example:
0x0fca20275697de6ebff30a293b3ceb21c003e972
organisation
Object
id
string
name
string
contact
Object
id
string
name
string
ownership_start
integer
Example:
1
ownership_end
integer
Example:
1
percentage
integer
Example:
100
Example 1
[
{
"id": "",
"name": "",
"description": "",
"nft_type": "",
"created_date": "",
"image": {
"id": "string",
"type": "LOGO",
"width": 1,
"height": 1,
"format": "string",
"url": "string",
"thumbnailUrl": "string",
"publicId": "string",
"media": [
{
"width": 1,
"height": 1,
"url": "string"
}
]
},
"video": {
"id": "string",
"type": "LOGO",
"width": 1,
"height": 1,
"format": "string",
"url": "string",
"thumbnailUrl": "string",
"publicId": "string",
"media": [
{
"width": 1,
"height": 1,
"url": "string"
}
]
},
"is_ipfs": true,
"is_fractional": true,
"is_transferable": true,
"rank": 1,
"series": {
"issue": "",
"total": ""
},
"lifecycle": "RANKED",
"campaign": {
"id": "",
"name": "",
"description": ""
},
"tier": {
"id": "",
"name": "",
"description": "",
"rank_min": "",
"rank_max": "",
"color_code": "",
"priority": 1
},
"template": {
"id": "",
"name": "",
"description": ""
},
"collection": {
"id": "",
"name": "",
"description": ""
},
"blockchains": [
{
"id": "",
"minted_date": "",
"platform": "",
"token": {
"id": "",
"token_type": ""
}
}
],
"owners": [
{
"id": "",
"wallet_id": "0x0fca20275697de6ebff30a293b3ceb21c003e972",
"organisation": {
"id": "",
"name": ""
},
"contact": {
"id": "",
"name": ""
},
"ownership_start": 1,
"ownership_end": 1,
"percentage": 100
}
]
}
]Atttrubutes for an NFT
Object
id
string
name
string
Attribute name
Example:
rarity
description
string
How rare is the NFT
attribute_value
string
Example:
Critically Endangered
lexicon
string
json supported element name
Example:
nft.rarity
iso639-2
string
Example:
eng
attribute_type
string
Enumeration:
TEXT
NUMERIC
MEDIA
Array
Object
id
string
display_name
string
name
string
description
string
market_fee
integer
Example:
1
Example 1
[
{
"id": "",
"name": "",
"description": "",
"long_description": "",
"market_fee": 1,
"display_name": "",
"website_url": "",
"socials": {
"facebook_url": "",
"twitter_url": "",
"medium_url": "",
"github_url": "",
"discord_url": "",
"telegram_url": "",
"youtube_url": ""
}
}
]
Object
id
string
name
string
description
string
long_description
string
market_fee
integer
Example:
1
display_name
string
website_url
string
socials
Object
facebook_url
string
twitter_url
string
medium_url
string
github_url
string
discord_url
string
telegram_url
string
youtube_url
string
taxon
string
image
video
background_image
integration
Object
id
string
name
string
icon
Object
active
string
in-active
string
Example 1
{
"id": "",
"name": "",
"description": "",
"long_description": "",
"market_fee": 1,
"display_name": "",
"website_url": "",
"socials": {
"facebook_url": "",
"twitter_url": "",
"medium_url": "",
"github_url": "",
"discord_url": "",
"telegram_url": "",
"youtube_url": ""
}
}Generic Creatives Array
Object
id
string
Example:
0e02f4ab-797c-405c-8bf7-14651e28fe05
usage_type
unknown
nullable
width
integer
Example:
259
format
string
Example:
jpg
media_id
unknown
nullable
media
Array
Object
width
integer
Example:
50
height
integer
Example:
37
url
string
Example:
https://res.cloudinary.com/image/upload/c_scale,f_auto,q_auto,w_50/v1/bg/v6z5d9dq7wktaqmm5nbm.jpg
url
string
Example:
https://res.cloudinary.com/vizulink-tech-lmimited/image/upload/v1/bg/v6z5d9dq7wktaqmm5nbm.jpg
height
integer
Example:
194
media_group
Object
id
string
name
string
public_id
string
Example:
bg/v6z5d9dq7wktaqmm5nbm
Object
id
string
name
string
vintage
Object
vintage
string
String form of vintage
Example:
2014 - 2016
vintage_from
integer
2014
vintage_to
integer
unit_type
string
Example:
VCU
purchase_date
number
carbon
Object
open_balance
number
current_balance
number
costs
Object
purchase_price
number
currency
string
Example:
USD
serial_number
string
supplier
Object
id
string
name
string
consigned
Object
id
string
name
string
verifier_reference
string
Simple Financials to record transctional cost and sales for multiple currency
Object
id
string
financial_type
string
Type of transaction amount Cost or Sale, with multiple sales reflecting differenct currencies for the same transaction
Enumeration:
COST
SALE
wallet
number
Total sales price based on number of units
Example:
154.5
amount
number
amount of sale or cost in given currency.
Example:
15.45
is_conversion
boolean
currency_code
string
USD
rate
number
Total cost price of transction
Example:
144.5
Atttrubutes for an Collection used for defining the NFT
Object
id
string
nft_type
string
Enumeration:
MERCHANDISE
RETIREMENT
name
string
Attribute name
Example:
rarity
description
string
How rare is the NFT
attribute_value
string
Example:
Critically Endangered
lexicon
string
json supported element name
Example:
nft.rarity
iso639-2
string
Example:
eng
attribute_type
string
Enumeration:
TEXT
NUMERIC
MEDIA
Used to link the orginal product catalog item, that can be used as base properties for an NFT
Object
integration
Object
id
string
name
string
id
string
name
string
Example:
Island NFT
description
string
Example:
There are 10,000 Island Innovation Impact NFTs and each represents 1 seedling being planted by Fundacion Groupo Social. 70% of the money is spent buying and planting seedlings, 15% supports Island Innovation and 15% supports Meta Carbon Inc.
sku
string
family
string
Example:
Island Innovatoion
brand
string
Ownership object
Object
id
string
wallet_id
Object
id
string
wallet_address
string
organisation
Object
id
string
name
string
contact
Object
id
string
name
string
ownership_start
number
ownership_end
number
percentage
number
Object
id
string
name
string
vintage
Object
from_date
integer
to_date
integer
unit_type
string
Example:
VCU
costs
Object
unit_cost
number
pricing
Array
Object
id
string
Example:
95ac16e3-c194-11ec-a97e-42010a9a0008
name
string
Example:
Island Innovation NFT
price_model
string
Example:
FLAT
sales_prices
Array
Object
id
string
Example:
38186aea-c18d-11ec-a97e-42010a9a0008
location_code
string
Example:
UK
currency
string
Example:
USDC
display_price
string
Example:
$40.00
effective_date
number
price
number
tax_model
string
Example:
INCLUSIVE
block
Object
start_block
integer
Example:
1
end_block
integer
Example:
1
total_blocks
integer
Example:
1
Metadata templates for grouping schema attributes
Object
id
string
name
string
description
string
platform_id
string
Unique ID on external Platform
image
Object
id
string
name
string
description
string
start_date
string
end_date
string
account
string
collection
Object
id
string
name
string
blockchain_receiver
string
integration
Object
id
string
name
string
icon
string
receiver_wallet
Object
id
string
alias
string
wallet_address
string
Object
content
Array
Object
id
string
Example:
138cbd4a-d4de-e855-209d-1aef4885bd5f
retirement_date
integer
Example:
1698676497
requested_date
unknown
nullable
serial_number
string
Example:
TTBD
inventory
Object
id
string
Example:
ab624d7a-e9a9-4bd8-88c8-554af6d79938
vintage
Object
name
unknown
nullable
vintage_from
string
Example:
2019
vintage_to
string
Example:
2019
unit_type
unknown
nullable
purchase_date
integer
Example:
1698676471
carbon
Object
open_balance
unknown
nullable
current_balance
integer
Example:
98000
costs
Object
purchase_price
integer
Example:
15
currency
string
Example:
USD
purchase_date
unknown
nullable
serial_number
string
Example:
6470-322716054-322726053-VCU-024-MER-GT-14-1622-01012016-31122016-1
supplier
Object
id
string
Example:
87ed427e-3a64-11ed-adf6-42010a9a000c
name
string
Example:
Demo Account
is_active
boolean
Example:
true
verifier_reference
unknown
nullable
project
Object
id
string
Example:
6015cab0-4ed8-11ed-aec0-42010a9a0004
name
string
Example:
Cordillera Azul
image
Object
id
string
Example:
a8950581-768d-43fb-a7af-b2df5bee7ae4
type
string
Example:
PHOTO
width
integer
Example:
1536
height
integer
Example:
2048
format
string
Example:
jpg
url
string
Example:
https://res.cloudinary.com/vizulink-tech-lmimited/image/upload/v1/crm/c74cd62c-4b99-4291-b083-d0ad7aa69c7d/brh0temdkbzetqhpe0fz.jpg
thumbnail_url
string
Example:
https://res.cloudinary.com/vizulink-tech-lmimited/image/upload/t_media_lib_thumb/v1/crm/c74cd62c-4b99-4291-b083-d0ad7aa69c7d/brh0temdkbzetqhpe0fz.jpg
public_id
string
Example:
crm/c74cd62c-4b99-4291-b083-d0ad7aa69c7d/brh0temdkbzetqhpe0fz
technology
string
Example:
CLOUDINARY
media
Array
Object
id
string
Example:
1a7f06b2-c3e9-421f-9f52-2c1f3d2b3c5f
width
integer
Example:
50
height
integer
Example:
66
url
string
Example:
https://res.cloudinary.com/vizulink-tech-lmimited/image/upload/c_scale,f_auto,q_auto,w_50/v1/crm/c74cd62c-4b99-4291-b083-d0ad7aa69c7d/brh0temdkbzetqhpe0fz.jpg
technology
string
Example:
CLOUDINARY
public_id
string
Example:
crm/c74cd62c-4b99-4291-b083-d0ad7aa69c7d/brh0temdkbzetqhpe0fz
created_on
integer
Example:
1664383048000
media_external_id
string
Example:
66c0add3-9a94-442a-8df3-9a9d841717f5
media_group_external_id
string
Example:
66c0add3-9a94-442a-8df3-9a9d841717f5
resource_type
string
Example:
image
registry
Object
id
string
Example:
36ca5da6-6c0b-11ed-aec0-42010a9a0004
name
string
Example:
VERRA
consigned_to
Object
id
unknown
nullable
name
unknown
nullable
date
unknown
nullable
consignments
Object
consigned_count
integer
open_co2_balance
unknown
nullable
current_co2_balance
unknown
nullable
sale
Object
amount
integer
Example:
25
currency
string
Example:
USD
date
unknown
nullable
account
Object
name
unknown
nullable
id
string
Example:
841d528d-3112-11ed-adf6-42010a9a000c
beneficiary
Object
name
string
Example:
Stand For Trees
id
string
Example:
b9a5d84d-3112-11ed-adf6-42010a9a000c
certifications
string
reason
Object
id
string
Example:
ec502490-3f14-11ed-adf6-42010a9a000a
name
string
Example:
Carbon Offset
description
string
Example:
Carbon Offset
registry
Object
id
string
Example:
36ca5da6-6c0b-11ed-aec0-42010a9a0004
name
string
Example:
VERRA
blocks
Object
units
integer
Example:
2000
unit_type
string
Example:
VCU
is_pending
boolean
Example:
true
offset_url
string
Example:
TBD
campaign
Object
name
string
Example:
SFT - WooCommerce
id
string
Example:
770b4142-ce5e-443f-b3ed-01d2605fef85
project
Object
name
string
Example:
Cordillera Azul
id
string
Example:
6015cab0-4ed8-11ed-aec0-42010a9a0004
nft
Object
id
string
Example:
6edfe137-8969-4ef5-8540-477d42099782
name
string
Example:
Template Test
lifecycle
string
Example:
PENDING
fractional
Object
count
string
pageable
Object
sort
Object
empty
boolean
Example:
true
sorted
boolean
unsorted
boolean
Example:
true
offset
integer
page_number
integer
page_size
integer
Example:
10
paged
boolean
Example:
true
unpaged
boolean
last
boolean
Example:
true
total_pages
integer
Example:
1
total_elements
integer
Example:
9
size
integer
Example:
10
number
integer
sort
Object
empty
boolean
Example:
true
sorted
boolean
unsorted
boolean
Example:
true
first
boolean
Example:
true
number_of_elements
integer
Example:
9
empty
boolean
GET
/campaigns/
{id}/projects
PUT
/campaign_project/id
GET
/campaigns/id
PUT
/campaigns/id
DELETE
/campaigns/id
GET
/campaigns/
{id}/projects
GET
/campaigns/
{id}/projectsPath variables
id
string
required
GET
/campaigns/id
Responses
200
OK
Body
Examples
{
"id": "",
"name": "",
"description": "",
"start_date": "",
"end_date": "",
"account": "",
"collection": {
"id": "",
"name": ""
},
"blockchain_receiver": "",
"integration": {
"id": "",
"name": "",
"icon": ""
},
"receiver_wallet": {
"id": "",
"alias": "",
"wallet_address": ""
}
}
PUT
/campaigns/id
Request body
Object
name
string
description
string
start_date
string
end_date
string
campaign_type
string
integration
Object
id
string
blockchain_receiver
string
account
string
collection
Object
id
string
receiver_wallet
Object
id
string
Responses
200
OK
Body
Examples
{
"id": "",
"name": "",
"description": "",
"start_date": "",
"end_date": "",
"account": "",
"collection": {
"id": "",
"name": ""
},
"blockchain_receiver": "",
"integration": {
"id": "",
"name": "",
"icon": ""
},
"receiver_wallet": {
"id": "",
"alias": "",
"wallet_address": ""
}
}
GET
/campaigns/
{id}/projectsPath variables
id
string
required
Responses
200
OK
Body
Array
Object
id
string
co2_offset_kilos
string
Offset kilo amount from wallet transactions
project
Object
template
retirements
Array
Object
id
string
retirement_date
string
serial_number
string
carbon
Object
Example 1
GET /campaigns/{id}/projects HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
[
{
"id": "",
"co2_offset_kilos": "",
"project": {
"id": "",
"name": "",
"description": "",
"creatives": {
"id": "string",
"type": "LOGO",
"width": 1,
"height": 1,
"format": "string",
"url": "string",
"thumbnailUrl": "string",
"publicId": "string",
"media": [
{
"width": 1,
"height": 1,
"url": "string"
}
]
}
},
"template": {
"id": "",
"name": "",
"description": "",
"platform_id": "",
"image": {
"id": "string",
"type": "LOGO",
"width": 1,
"height": 1,
"format": "string",
"url": "string",
"thumbnailUrl": "string",
"publicId": "string",
"media": [
{
"width": 1,
"height": 1,
"url": "string"
}
]
}
},
"retirements": [
{
"id": "",
"retirement_date": "",
"serial_number": "",
"carbon": {
"retired_co2": "",
"merchandise_co2": "",
"nft": {
"id": "",
"name": "",
"image": {
"id": "0e02f4ab-797c-405c-8bf7-14651e28fe05",
"usage_type": null,
"width": 259,
"format": "jpg",
"media_id": null,
"media": [
{
"width": 50,
"height": 37,
"url": "https://res.cloudinary.com/image/upload/c_scale,f_auto,q_auto,w_50/v1/bg/v6z5d9dq7wktaqmm5nbm.jpg"
}
],
"url": "https://res.cloudinary.com/vizulink-tech-lmimited/image/upload/v1/bg/v6z5d9dq7wktaqmm5nbm.jpg",
"height": 194,
"media_group": {
"id": "",
"name": ""
},
"public_id": "bg/v6z5d9dq7wktaqmm5nbm"
}
}
}
}
]
}
]
GET
/templates
GET
/templates/id
GET
/template/id/attributes
POST
/templates
PUT
/template/id/attributes
POST
/template/id/collections
DELETE
/templates/id/collections/id
PUT
/templates/id
GET
/templates
Responses
200
OK
Body
Examples
[
{
"id": "",
"name": "",
"description": "",
"is_transferable": true,
"is_burnable": "",
"supply": {
"max": 1,
"minted": 1
},
"image": {
"id": "string",
"type": "LOGO",
"width": 1,
"height": 1,
"format": "string",
"url": "string",
"thumbnailUrl": "string",
"publicId": "string",
"media": [
{
"width": 1,
"height": 1,
"url": "string"
}
]
},
"back_image": {
"id": "string",
"type": "LOGO",
"width": 1,
"height": 1,
"format": "string",
"url": "string",
"thumbnailUrl": "string",
"publicId": "string",
"media": [
{
"width": 1,
"height": 1,
"url": "string"
}
]
},
"video": {
"id": "string",
"type": "LOGO",
"width": 1,
"height": 1,
"format": "string",
"url": "string",
"thumbnailUrl": "string",
"publicId": "string",
"media": [
{
"width": 1,
"height": 1,
"url": "string"
}
]
},
"back_video": {
"id": "string",
"type": "LOGO",
"width": 1,
"height": 1,
"format": "string",
"url": "string",
"thumbnailUrl": "string",
"publicId": "string",
"media": [
{
"width": 1,
"height": 1,
"url": "string"
}
]
},
"schema_id": {
"id": "",
"name": "",
"description": ""
},
"is_ipfs": true
}
]
GET
/templates/id
Responses
200
OK
Body
Examples
{
"id": "",
"name": "",
"description": "",
"is_transferable": true,
"is_burnable": "",
"supply": {
"max": 1,
"minted": 1
},
"image": {
"id": "string",
"type": "LOGO",
"width": 1,
"height": 1,
"format": "string",
"url": "string",
"thumbnailUrl": "string",
"publicId": "string",
"media": [
{
"width": 1,
"height": 1,
"url": "string"
}
]
},
"back_image": {
"id": "string",
"type": "LOGO",
"width": 1,
"height": 1,
"format": "string",
"url": "string",
"thumbnailUrl": "string",
"publicId": "string",
"media": [
{
"width": 1,
"height": 1,
"url": "string"
}
]
},
"video": {
"id": "string",
"type": "LOGO",
"width": 1,
"height": 1,
"format": "string",
"url": "string",
"thumbnailUrl": "string",
"publicId": "string",
"media": [
{
"width": 1,
"height": 1,
"url": "string"
}
]
},
"back_video": {
"id": "string",
"type": "LOGO",
"width": 1,
"height": 1,
"format": "string",
"url": "string",
"thumbnailUrl": "string",
"publicId": "string",
"media": [
{
"width": 1,
"height": 1,
"url": "string"
}
]
},
"schema_id": {
"id": "",
"name": "",
"description": ""
},
"is_ipfs": true
}
GET
/template/id/attributes
Responses
200
OK
Body
Examples
[
{
"id": "",
"schema_attribute": {
"id": "",
"attribute_name": "",
"lexicon": "",
"attribute_type": "",
"priority": ""
},
"default_value": ""
}
]
PUT
/template/id/attributes
Request body
Array
Object
id
string
schema_attributes
Object
id
string
default_value
string
Examples
[
{
"id": "",
"schema_attributes": {
"id": ""
},
"default_value": ""
}
]Responses
200
OK
Body
Examples
[
{
"id": "",
"schema_attribute": {
"id": "",
"attribute_name": "",
"lexicon": "",
"attribute_type": "",
"priority": ""
},
"default_value": ""
}
]
PUT
/templates/id
Request body
Object
name
string
description
string
is_transferable
boolean
is_burnable
boolean
supply
Object
issued
number
max
number
schema
Object
Example:
iid
string
is_ipfs
boolean
image
Object
id
string
video
Object
id
string
back_image
Object
id
string
back_video
Object
id
string
Examples
{
"name": "",
"description": "",
"is_transferable": true,
"is_burnable": true,
"supply": {
"issued": 1,
"max": 1
},
"schema": {
"id": ""
},
"is_ipfs": true,
"image": {
"id": ""
},
"video": {
"id": ""
},
"back_image": {
"id": ""
},
"back_video": {
"id": ""
}
}Responses
200
OK
Body
Examples
{
"id": "",
"name": "",
"description": "",
"is_transferable": true,
"is_burnable": "",
"supply": {
"max": 1,
"minted": 1
},
"image": {
"id": "string",
"type": "LOGO",
"width": 1,
"height": 1,
"format": "string",
"url": "string",
"thumbnailUrl": "string",
"publicId": "string",
"media": [
{
"width": 1,
"height": 1,
"url": "string"
}
]
},
"back_image": {
"id": "string",
"type": "LOGO",
"width": 1,
"height": 1,
"format": "string",
"url": "string",
"thumbnailUrl": "string",
"publicId": "string",
"media": [
{
"width": 1,
"height": 1,
"url": "string"
}
]
},
"video": {
"id": "string",
"type": "LOGO",
"width": 1,
"height": 1,
"format": "string",
"url": "string",
"thumbnailUrl": "string",
"publicId": "string",
"media": [
{
"width": 1,
"height": 1,
"url": "string"
}
]
},
"back_video": {
"id": "string",
"type": "LOGO",
"width": 1,
"height": 1,
"format": "string",
"url": "string",
"thumbnailUrl": "string",
"publicId": "string",
"media": [
{
"width": 1,
"height": 1,
"url": "string"
}
]
},
"schema_id": {
"id": "",
"name": "",
"description": ""
},
"is_ipfs": true
}
GET
/schemas
GET
/schemas/id
PUT
/schemas/id
GET
/schemas/id/attributes
PUT
/schemas/id/attributes
POST
/schemas
POST
/schemas/id/collections
DELETE
/schemas/id/collections/id
GET
/schemas
Responses
200
OK
Body
Examples
[
{
"id": "",
"name": "",
"description": "",
"attributes": [
{
"id": "",
"attribute_name": "",
"attribute_type": "",
"lexicon": ""
}
]
}
]
GET
/schemas/id
Responses
200
OK
PUT
/schemas/id
Request body
Object
name
string
description
string
Responses
200
OK
GET
/schemas/id/attributes
Responses
200
OK
Body
Examples
[
{
"id": "",
"attribute_name": "",
"attribute_type": "",
"lexicon": ""
}
]
PUT
/schemas/id/attributes
Request body
Array
Object
id
string
attribute_name
string
lexicon
string
attribute_type
string
priority
string
Examples
[
{
"id": "",
"attribute_name": "",
"lexicon": "",
"attribute_type": "",
"priority": ""
}
]Responses
200
OK
Body
Examples
[
{
"id": "",
"attribute_name": "",
"attribute_type": "",
"lexicon": ""
}
]
POST
/schemas
Request body
Examples
{
"id": "",
"name": "",
"description": ""
}Responses
201
Created
Object
properties
event
Object
created_on
integer
Example:
1696869855
id
string
Example:
86a9159f-b409-4c07-a8b2-769d3d603d73
type
string
Example:
TRANSACTION_CREATED
transaction
Object
id
string
Example:
guid
tx_id
string
Example:
TX-TEST-102
transaction_date
integer
Example:
1696865602
reference
string
Example:
Brazil 1 Ton
base_currency
Object
amount
integer
Example:
25
currency
string
Example:
USD
source_currency
Object
amount
unknown
nullable
currency
unknown
nullable
conversion_rate
unknown
nullable
wallet
Object
id
string
Example:
26a14220-a38e-4db9-87f1-d4df7266846f
alias
string
Example:
Jim.C***h-290
wallet_address
string
Example:
8acf5844cd31cb6a6c3def1586722e52
contact
Object
id
string
Example:
c3d796b4-89ee-45ae-b7da-08e60beb3c6d
name
string
Example:
Jim Crush
email
string
Example:
andy+jim@meta-carbon.com
phone
string
Example:
+447566224885
contact_type
unknown
nullable
co2_kg_units
integer
Example:
1000
project
Object
id
string
Example:
6015cbe1-4ed8-11ed-aec0-42010a9a0004
name
string
Example:
Brazilian Rosewood
external_reference
Array
Object
id
string
Example:
633c9b5e-0ed2-11ee-9b0a-42010a9a0007
integration
Object
name
string
Example:
Woo Commerce ( SFT AUTO )
id
string
Example:
a64685fe-5883-44ee-89f2-b1345f7c6b17
external_reference
string
Example:
100000000001652
campaign
Object
name
string
Example:
SFT - WooCommerce
id
string
Example:
770b4142-ce5e-443f-b3ed-01d2605fef85
additional properties
string
Example 1
{
"event": {
"created_on": 1696869855,
"id": "86a9159f-b409-4c07-a8b2-769d3d603d73",
"type": "TRANSACTION_CREATED"
},
"transaction": {
"id": "guid",
"tx_id": "TX-TEST-102",
"transaction_date": 1696865602,
"reference": "Brazil 1 Ton",
"base_currency": {
"amount": 25,
"currency": "USD"
},
"source_currency": {
"amount": null,
"currency": null
},
"conversion_rate": null,
"wallet": {
"id": "26a14220-a38e-4db9-87f1-d4df7266846f",
"alias": "Jim.C***h-290",
"wallet_address": "8acf5844cd31cb6a6c3def1586722e52"
},
"contact": {
"id": "c3d796b4-89ee-45ae-b7da-08e60beb3c6d",
"name": "Jim Crush",
"email": "andy+jim@meta-carbon.com",
"phone": "+447566224885",
"contact_type": null
},
"co2_kg_units": 1000,
"project": {
"id": "6015cbe1-4ed8-11ed-aec0-42010a9a0004",
"name": "Brazilian Rosewood",
"external_reference": [
{
"id": "633c9b5e-0ed2-11ee-9b0a-42010a9a0007",
"integration": {
"name": "Woo Commerce ( SFT AUTO )",
"id": "a64685fe-5883-44ee-89f2-b1345f7c6b17"
},
"external_reference": "100000000001652"
}
]
},
"campaign": {
"name": "SFT - WooCommerce",
"id": "770b4142-ce5e-443f-b3ed-01d2605fef85"
}
},
"[...]": ""
}
Object
event
Object
created_on
integer
Example:
1696870766
id
string
Example:
706bc402-7aca-41a5-a7ff-cd9f414b619c
type
string
Example:
RETIREMENT_CREATED
beneficiary
Object
id
string
Example:
b9a5d84d-3112-11ed-adf6-42010a9a000c
name
string
Example:
Stand For Trees
project
Object
id
string
Example:
6015cbe1-4ed8-11ed-aec0-42010a9a0004
name
string
Example:
Brazilian Rosewood
external_reference
Array
Object
id
string
Example:
633c9b5e-0ed2-11ee-9b0a-42010a9a0007
integration
Object
name
string
Example:
Woo Commerce ( SFT AUTO )
id
string
Example:
a64685fe-5883-44ee-89f2-b1345f7c6b17
external_reference
string
Example:
100000000001652
contact
Object
id
string
name
string
email
string
phone
string
contact_type
string
carbon
Object
inventory
Object
id
string
serial_number
string
serial_number
string
registry_url
string
retirement_date
string
is_pending
boolean
co2_kilo_units
number
fraction_count
string
Number of fractional transactions
Object
id
string
Example:
4654a3ca-5008-f863-963d-55b5fd5c78f2
retirement_date
integer
Example:
1696879952
requested_date
unknown
nullable
serial_number
string
Example:
TBD
inventory
Object
id
string
Example:
660865a5-2799-47bb-8298-9499ce9dd447
vintage
Object
name
unknown
nullable
vintage_from
string
Example:
2019
vintage_to
string
Example:
2019
unit_type
unknown
nullable
purchase_date
integer
Example:
1696879017
carbon
Object
open_balance
unknown
nullable
current_balance
integer
Example:
498000
costs
Object
purchase_price
integer
Example:
15
currency
string
Example:
USD
purchase_date
unknown
nullable
serial_number
string
Example:
6470-322716054-322726053-VCU-024-MER-GT-14-1622-01012016-31122016-1
supplier
Object
id
string
Example:
c4715b54-65c1-11ed-aec0-42010a9a0004
name
string
Example:
AirCarbon
is_active
boolean
Example:
true
verifier_reference
unknown
nullable
project
Object
id
string
Example:
6015cbe1-4ed8-11ed-aec0-42010a9a0004
name
string
Example:
Brazilian Rosewood
image
Object
id
string
Example:
adf96d95-5602-44c6-b38d-3534423c523d
type
string
Example:
PHOTO
width
integer
Example:
4608
height
integer
Example:
3456
format
string
Example:
jpg
url
string
Example:
https://res.cloudinary.com/vizulink-tech-lmimited/image/upload/v1/crm/c74cd62c-4b99-4291-b083-d0ad7aa69c7d/w8eovt8ushrxwsyga2n8.jpg
thumbnail_url
string
Example:
https://res.cloudinary.com/vizulink-tech-lmimited/image/upload/t_media_lib_thumb/v1/crm/c74cd62c-4b99-4291-b083-d0ad7aa69c7d/w8eovt8ushrxwsyga2n8.jpg
public_id
string
Example:
crm/c74cd62c-4b99-4291-b083-d0ad7aa69c7d/w8eovt8ushrxwsyga2n8
technology
string
Example:
CLOUDINARY
media
Array
Object
id
string
Example:
1a5b189b-ebd8-4d97-941c-53f012583b71
width
integer
Example:
50
height
integer
Example:
37
url
string
Example:
https://res.cloudinary.com/vizulink-tech-lmimited/image/upload/c_scale,f_auto,q_auto,w_50/v1/crm/c74cd62c-4b99-4291-b083-d0ad7aa69c7d/w8eovt8ushrxwsyga2n8.jpg
technology
string
Example:
CLOUDINARY
public_id
string
Example:
crm/c74cd62c-4b99-4291-b083-d0ad7aa69c7d/w8eovt8ushrxwsyga2n8
created_on
integer
Example:
1664383229000
media_external_id
string
Example:
04f932e4-ba57-47cb-b9da-613d99fd451f
media_group_external_id
string
Example:
04f932e4-ba57-47cb-b9da-613d99fd451f
resource_type
string
Example:
image
registry
Object
id
string
Example:
88b21fb8-765d-11ed-a040-42010a9a0003
name
string
Example:
IHS MARKIT
consigned_to
Object
id
unknown
nullable
name
unknown
nullable
date
unknown
nullable
consignments
Object
consigned_count
integer
open_co2_balance
unknown
nullable
current_co2_balance
unknown
nullable
sale
Object
amount
integer
Example:
25
currency
string
Example:
USD
date
unknown
nullable
account
Object
name
string
Example:
Meta Carbon
id
string
Example:
841d528d-3112-11ed-adf6-42010a9a000c
beneficiary
Object
name
string
Example:
Stand For Trees
id
string
Example:
b9a5d84d-3112-11ed-adf6-42010a9a000c
certifications
unknown
nullable
reason
Object
id
string
Example:
ec502490-3f14-11ed-adf6-42010a9a000a
name
string
Example:
Carbon Offset
description
string
Example:
Carbon Offset
registry
Object
id
string
Example:
88b21fb8-765d-11ed-a040-42010a9a0003
name
string
Example:
IHS MARKIT
blocks
Object
units
integer
Example:
2000
unit_type
string
Example:
VCU
is_pending
boolean
Example:
true
offset_url
string
Example:
TBD
campaign
Object
name
string
Example:
SFT - WooCommerce
id
string
Example:
770b4142-ce5e-443f-b3ed-01d2605fef85
project
Object
name
string
Example:
Brazilian Rosewood
id
string
Example:
6015cbe1-4ed8-11ed-aec0-42010a9a0004
co2_kilos
unknown
nullable
actual_co2_offset
unknown
nullable
contact
unknown
nullable
GET
/campaigns/id/tiers
GET
/campaigns/id/tiers/id
POST
/campaigns/id/tiers
GET
/campaigns/id/tiers
Responses
200
OK
Body
Examples
[
{
"id": "",
"name": "",
"description": "",
"rank": {
"min": "",
"max": ""
},
"colour_code": "",
"template": {
"id": "",
"name": ""
},
"priority": 1
}
]
GET
/campaigns/id/tiers/id
Responses
200
OK
Body
Examples
{
"id": "",
"name": "",
"description": "",
"rank": {
"min": "",
"max": ""
},
"colour_code": "",
"template": {
"id": "",
"name": ""
},
"priority": 1
}
POST
/campaigns/id/tiers
Request body
Object
name
string
description
string
rank
Object
min
string
max
string
colour_code
string
template
Object
id
string
priority
number
Responses
201
Created
Body
Examples
{
"id": "",
"name": "",
"description": "",
"rank": {
"min": "",
"max": ""
},
"colour_code": "",
"template": {
"id": "",
"name": ""
},
"priority": 1
}
GET
/campaigns/
{id}/projects
GET
/campaigns/
{id}/projectsPath variables
id
string
required
Responses
200
OK
Body
Object
id
string
Example:
c84929ca-0c1a-4445-b738-ca932ed1b293
project
Object
id
string
Example:
6015b18f-4ed8-11ed-aec0-42010a9a0004
name
string
Example:
Southern Cardamom
description
string
Example:
"Rangers from this project confiscate more than 1,500 chainsaws a year. That's around 5 a day and each one can clear cut up to one hectare every day!
image
Object
id
string
Example:
3617f2c9-9b5f-4661-b23e-d3c8247cd5ad
type
string
Example:
PHOTO
width
integer
Example:
3992
height
integer
Example:
2992
format
string
Example:
jpg
url
string
Example:
https://res.cloudinary.com/vizulink-tech-lmimited/image/upload/v1/crm/c74cd62c-4b99-4291-b083-d0ad7aa69c7d/mnk48n6y1nk1ojwv3rey.jpg
thumbnail_url
string
Example:
https://res.cloudinary.com/vizulink-tech-lmimited/image/upload/t_media_lib_thumb/v1/crm/c74cd62c-4b99-4291-b083-d0ad7aa69c7d/mnk48n6y1nk1ojwv3rey.jpg
public_id
string
Example:
crm/c74cd62c-4b99-4291-b083-d0ad7aa69c7d/mnk48n6y1nk1ojwv3rey
technology
string
Example:
CLOUDINARY
media
Array
Object
id
string
Example:
323ed829-6239-43ce-994b-0a5a908d1d6b
width
integer
Example:
50
height
integer
Example:
37
url
string
Example:
https://res.cloudinary.com/vizulink-tech-lmimited/image/upload/c_scale,f_auto,q_auto,w_50/v1/crm/c74cd62c-4b99-4291-b083-d0ad7aa69c7d/mnk48n6y1nk1ojwv3rey.jpg
technology
string
Example:
CLOUDINARY
public_id
string
Example:
crm/c74cd62c-4b99-4291-b083-d0ad7aa69c7d/mnk48n6y1nk1ojwv3rey
created_on
integer
Example:
1664382552000
media_external_id
string
Example:
2c7cbfa5-7861-4347-8a4c-8e06fd3f0e8d
media_group_external_id
string
Example:
2c7cbfa5-7861-4347-8a4c-8e06fd3f0e8d
resource_type
string
Example:
image
location
Object
region
unknown
nullable
country
string
Example:
Cambodia
continent
string
Example:
Asia
location
unknown
nullable
boundary
unknown
nullable
iso_3166_1
string
Example:
KH
iso_3166_2
string
Example:
KHM
template
Object
id
string
Example:
426b4259-b6eb-4e03-ad67-51c3319c90e1
name
string
Example:
Mountain Gorilla - Platinum
description
string
Example:
Platinum Level Gorilla
image
Object
id
unknown
nullable
type
string
Example:
PHOTO
width
unknown
nullable
height
unknown
nullable
format
string
Example:
IPFS
url
string
Example:
https://ipfs.io/ipfs/QmetYcq9xVwopTVg62ezgjXphbPZ5W9hnjtdNJL2GQ39Qx
thumbnail_url
unknown
nullable
public_id
string
Example:
QmetYcq9xVwopTVg62ezgjXphbPZ5W9hnjtdNJL2GQ39Qx
technology
unknown
nullable
media
Array
Object
id
string
Example:
QmetYcq9xVwopTVg62ezgjXphbPZ5W9hnjtdNJL2GQ39Qx
width
integer
height
integer
url
string
Example:
https://ipfs.io/ipfs/QmetYcq9xVwopTVg62ezgjXphbPZ5W9hnjtdNJL2GQ39Qx
technology
string
Example:
IPFS
public_id
string
Example:
QmetYcq9xVwopTVg62ezgjXphbPZ5W9hnjtdNJL2GQ39Qx
created_on
unknown
nullable
media_external_id
unknown
nullable
media_group_external_id
unknown
nullable
resource_type
unknown
nullable
is_transferable
boolean
Example:
true
is_burnable
boolean
Example:
true
issued_supply
unknown
nullable
max_supply
integer
Example:
10
carbon
Object
retired_count
number
number of retirements related to campaign_id
retired_co2_kilo_amount
number
Total amount retired for the campaign
total_co2_kilo_amount
number
Total can be more than the retired amount meaning another retirement is required use sum from wallet transaction per project
Example 1
GET /campaigns/{id}/projects HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "c84929ca-0c1a-4445-b738-ca932ed1b293",
"project": {
"id": "6015b18f-4ed8-11ed-aec0-42010a9a0004",
"name": "Southern Cardamom",
"description": "\"Rangers from this project confiscate more than 1,500 chainsaws a year. That's around 5 a day and each one can clear cut up to one hectare every day!",
"image": {
"id": "3617f2c9-9b5f-4661-b23e-d3c8247cd5ad",
"type": "PHOTO",
"width": 3992,
"height": 2992,
"format": "jpg",
"url": "https://res.cloudinary.com/vizulink-tech-lmimited/image/upload/v1/crm/c74cd62c-4b99-4291-b083-d0ad7aa69c7d/mnk48n6y1nk1ojwv3rey.jpg",
"thumbnail_url": "https://res.cloudinary.com/vizulink-tech-lmimited/image/upload/t_media_lib_thumb/v1/crm/c74cd62c-4b99-4291-b083-d0ad7aa69c7d/mnk48n6y1nk1ojwv3rey.jpg",
"public_id": "crm/c74cd62c-4b99-4291-b083-d0ad7aa69c7d/mnk48n6y1nk1ojwv3rey",
"technology": "CLOUDINARY",
"media": [
{
"id": "323ed829-6239-43ce-994b-0a5a908d1d6b",
"width": 50,
"height": 37,
"url": "https://res.cloudinary.com/vizulink-tech-lmimited/image/upload/c_scale,f_auto,q_auto,w_50/v1/crm/c74cd62c-4b99-4291-b083-d0ad7aa69c7d/mnk48n6y1nk1ojwv3rey.jpg",
"technology": "CLOUDINARY",
"public_id": "crm/c74cd62c-4b99-4291-b083-d0ad7aa69c7d/mnk48n6y1nk1ojwv3rey"
}
],
"created_on": 1664382552000,
"media_external_id": "2c7cbfa5-7861-4347-8a4c-8e06fd3f0e8d",
"media_group_external_id": "2c7cbfa5-7861-4347-8a4c-8e06fd3f0e8d",
"resource_type": "image"
},
"location": {
"region": null,
"country": "Cambodia",
"continent": "Asia",
"location": null,
"boundary": null,
"iso_3166_1": "KH",
"iso_3166_2": "KHM"
}
},
"template": {
"id": "426b4259-b6eb-4e03-ad67-51c3319c90e1",
"name": "Mountain Gorilla - Platinum",
"description": "Platinum Level Gorilla",
"image": {
"id": null,
"type": "PHOTO",
"width": null,
"height": null,
"format": "IPFS",
"url": "https://ipfs.io/ipfs/QmetYcq9xVwopTVg62ezgjXphbPZ5W9hnjtdNJL2GQ39Qx",
"thumbnail_url": null,
"public_id": "QmetYcq9xVwopTVg62ezgjXphbPZ5W9hnjtdNJL2GQ39Qx",
"technology": null,
"media": [
{
"id": "QmetYcq9xVwopTVg62ezgjXphbPZ5W9hnjtdNJL2GQ39Qx",
"width": 1,
"height": 1,
"url": "https://ipfs.io/ipfs/QmetYcq9xVwopTVg62ezgjXphbPZ5W9hnjtdNJL2GQ39Qx",
"technology": "IPFS",
"public_id": "QmetYcq9xVwopTVg62ezgjXphbPZ5W9hnjtdNJL2GQ39Qx"
}
],
"created_on": null,
"media_external_id": null,
"media_group_external_id": null,
"resource_type": null
},
"is_transferable": true,
"is_burnable": true,
"issued_supply": null,
"max_supply": 10
},
"carbon": {
"retired_count": 1,
"retired_co2_kilo_amount": 1,
"total_co2_kilo_amount": 1
}
}