self-service
Self Service API for APPS and Web
GET
/projects
GET
/projects/
{id}
GET
/projects/
{id}/carbon
GET
/projects/
{id}/collections
GET
/projects/
{id}/creatures
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
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
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": "",
"certificate_address": ""
}
],
"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
GET
/projects/
{id}/retirementsPath variables
id
string
required
Responses
200
OK
Body
Object
content
Array
Object
id
string
Example:
69de6a72-2797-11ed-b110-42010a9a0008
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
name
string
vintage
Object
vintage
string
Example:
2014 - 2016
vintage_from
integer
Example:
1
vintage_to
integer
Example:
1
unit_type
string
Example:
VCU
purchase_date
integer
Example:
1
costs
Object
purchase_price
integer
Example:
1
currency
string
Example:
USD
blocks
integer
Example:
1
serial_number
string
supplier
Object
id
string
name
string
verifier_reference
string
account
Object
id
string
name
string
description
string
beneficiary
Object
id
string
name
string
description
string
certifcations
Array
Object
id
string
name
string
Example:
CCB-Gold
reason
Object
id
string
name
string
description
string
registry
Array
Object
id
string
Example:
VERRA
name
string
certificate_address
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
nft
paging
Object
page_number
integer
Example:
1
page_size
integer
Example:
10
total_elements
integer
Example:
4
total_pages
integer
Example:
1
GET
/self-service/retirements/
{id}
GET
/self-service/retirements/
{id}Path variables
id
string
required
Responses
200
OK
Body
Object
id
string
Example:
de41d249-d7a0-44e0-87d8-29ac7b51c037
retirement_date
integer
Example:
1701964019
requested_date
integer
serial_number
string
Example:
10465-219735751-219735795-VCS-VCU-352-VER-BR-14-1382-01012016-31122016-1
beneficiary
Object
id
string
Example:
b9a5d84d-3112-11ed-adf6-42010a9a000c
name
string
Example:
Stand For Trees
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
is_pending
boolean
Example:
true
offset_url
string
Example:
https://registry.verra.org/myModule/rpt/myrpt.asp?r=206&h=184675
campaign
Object
id
string
Example:
bab088f5-7d90-11ee-aa28-42010a9a0006
name
string
Example:
Stand For Trees Q4
project
Object
name
string
Example:
Envira Amazonia
id
string
Example:
6015cdd2-4ed8-11ed-aec0-42010a9a0004
image
co2_kilos
unknown
nullable
actual_co2_offset
unknown
nullable
contact
unknown
nullable
transparency_url
string
Example:
https://carbon-creatures.com/retirement/de41d249-d7a0-44e0-87d8-29ac7b51c037
nft
Object
inventory
Object
id
string
name
string
POST
/transactions
POST
/wallets/
{id}/projects
GET
/wallets/
{id}/projects
POST
/supporters
GET
/supporters
GET
/supporters/
{id}
GET
/supporters/
{id}/projects
POST
/transactions
Request body
Object
transactionDate
string
Example:
2023-03-16T12:39:12.325Z
reference
string
Example:
string
baseCurrency
Object
amount
integer
currency
string
Example:
string
sourceCurrency
Object
amount
integer
currency
string
Example:
string
wallet
Object
id
string
Example:
string
alias
string
Example:
string
walletAddress
string
Example:
string
contact
Object
id
string
Example:
string
forename
string
Example:
fred
surname
string
Example:
smith
email
string
Example:
fred.smith@gmail.com
phone
string
Example:
+447566224395
project
Object
id
string
Example:
guidproject
campaign
Object
id
string
Example:
guidcampaign
co2KgUnits
integer
txId
string
Example:
string
receivedFrom
Object
id
string
Example:
string
alias
string
Example:
string
walletAddress
string
Example:
string
affiliate
Object
id
string
Example:
string
Example 1
POST /transactions HTTP/1.1
Content-Type: application/json
{
"transactionDate": "2023-03-16T12:39:12.325Z",
"reference": "string",
"baseCurrency": {
"amount": 1,
"currency": "string"
},
"sourceCurrency": {
"amount": 1,
"currency": "string"
},
"wallet": {
"id": "string",
"alias": "string",
"walletAddress": "string"
},
"contact": {
"id": "string",
"forename": "fred",
"surname": "smith",
"email": "fred.smith@gmail.com",
"phone": "+447566224395"
},
"project": {
"id": "guidproject"
},
"campaign": {
"id": "guidcampaign"
},
"co2KgUnits": 1,
"txId": "string",
"receivedFrom": {
"id": "string",
"alias": "string",
"walletAddress": "string"
},
"affiliate": {
"id": "string"
}
}
POST
/wallets/
{id}/projectsPath variables
id
string
required
Request body
Array
Object
id
string
Project ID
priority
string
percentage
number
Example 1
POST /projects/{id}/wallets HTTP/1.1
Content-Type: application/json
[
{
"wallet": {
"id": "",
"wallet_address": ""
},
"priority": "",
"wallet_role": "REVENUE"
}
]
GET
/wallets/
{id}/projectsPath variables
id
string
required
Either the Wallet ID provied by MC or external wallet address
Responses
200
OK
Body
Array
Object
project
Object
id
string
name
string
description
string
priority
integer
percentage
number
wallet_role
string
Role of the wallet will be SUPPORTER in self service
Example 1
GET /wallets/{id}/projects HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
[
{
"project": {
"id": "",
"name": "",
"description": ""
},
"priority": 1,
"percentage": 1,
"wallet_role": ""
}
]
POST
/supporters
Request body
Object
contact
Object
Details of the contact the ID can cross refrence an internal ID used by the host system, or generated by MC
id
string
alias
string
forename
string
surname
string
contact_email
string
wallet
Object
Wallet details for any transactions
wallet_address
string
project
Array
Project info that this contact wishes to support
Object
id
string
Example:
Project ID for supporter
priority
string
Example:
priority of support
percentage
number
If supporting multiple
Example 1
POST /supporters HTTP/1.1
Content-Type: application/json
{
"contact": {
"id": "",
"alias": "",
"forename": "",
"surname": "",
"contact_email": ""
},
"wallet": {
"wallet_address": ""
},
"project": [
{
"id": "Project ID for supporter",
"priority": "priority of support",
"percentage": 1
}
]
}
GET
/supporters
Request parameters
email
string
optional
Email Address
phone
string
optional
Phone Number
Responses
200
OK
Body
Object
contact
Object
id
string
alias
string
forename
string
surname
string
contact_email
string
contact_type
string
Enumeration:
PERSON
BUSINESS
business_name
string
wallet
Object
id
string
wallet_address
string
wallet_alias
string
GET
/supporters/
{id}Path variables
id
string
required
Responses
200
OK
Body
Object
contact
Object
id
string
alias
string
forename
string
surname
string
contact_email
string
contact_type
string
Enumeration:
PERSON
BUSINESS
business_name
string
wallet
Object
id
string
wallet_address
string
wallet_alias
string
GET
/supporters/
{id}/projectsPath variables
id
string
required
Responses
200
OK
Body
Array
Object
GET
/collections
GET
/collections/
{id}/products
GET
/collections/
{id}/templates
GET
/atttibute_schema
GET
/collections
Responses
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
id
string
name
string
description
string
owner
Object
id
string
name
string
description
string
projects
Array
Object
id
string
name
string
description
string
paging
Object
page_number
integer
Example:
1
page_size
integer
Example:
10
total_elements
integer
Example:
4
total_pages
integer
Example:
1
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
API’s to support Merchandising
GET
/campaigns
GET
/campaign/
{id}/rankings
GET
/projects/
{id}/rankings
GET
/rankings
GET
/campaigns
Request parameters
effecive.start
number
optional
effective.end
number
optional
project_id
string
optional
Responses
200
OK
Body
Object
id
string
name
string
description
string
effective
Object
start
number
Date of campaign start
end
number
Date campaign Ends
tiers
Array
Object
id
string
name
string
description
string
rank
Object
min
string
max
string
color_code
string
template
Object
id
string
name
string
description
string
product
Object
id
string
name
string
description
string
variant
Object
id
string
Example:
254ee619-9606-11ea-a45f-42010a9a005d
sku
string
Example:
LATTE-01-PRIMO
attributes
Array
Object
id
string
Example:
4649c3f3-95f7-11ea-a45f-42010a9a005d
variant_map
Object
id
string
Example:
640f62a8-95c0-11ea-a45f-42010a9a005d
name
string
Example:
Size
variant_value
string
Example:
Primo
creatives
creature
projects
Array
Object
id
string
name
string
description
string
Example 1
GET /campaigns HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "",
"project": {
"id": "",
"name": "",
"description": ""
},
"tier": {
"id": "",
"name": "",
"description": "",
"rank": {
"min": "",
"max": ""
},
"color_code": ""
},
"creature": {
"id": "",
"name": "",
"description": "",
"iucn_status": "EXTINCT",
"iucn_url": ""
},
"template": {
"id": "",
"name": "",
"description": "",
"product": {
"id": "",
"name": "",
"description": "",
"variants": [
{
"id": "254ee619-9606-11ea-a45f-42010a9a005d",
"sku": "LATTE-01-PRIMO",
"barcode": "1567890123",
"attributes": [
{
"id": "4649c3f3-95f7-11ea-a45f-42010a9a005d",
"variant_map": {
"id": "640f62a8-95c0-11ea-a45f-42010a9a005d",
"name": "Size"
},
"variant_value": "Primo"
}
]
}
],
"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"
},
"creature": {
"id": "",
"name": "",
"description": "",
"iucn_status": "EXTINCT_WILD",
"iucn_url": ""
}
}
},
"effective": {
"start": 1,
"end": 1
}
}
GET
/campaign/
{id}/rankingsGet the current rankings for a campaign across the projects supported ordered by project
Path variables
id
string
required
Request parameters
effective.start
number
optional
Start date time of the ranking
effective.end
number
optional
project_id
string
optional
Filter project ID’s otherwise all projects will be assigned
Example:
guid
Responses
200
OK
Body
Object
content
Array
Object
rank
integer
Example:
1
contact
Object
id
string
alias
string
forename
string
surname
string
wallet
Object
id
string
alias
string
wallet_address
string
project
Object
id
string
nname
string
carbon
number
paging
Object
page_number
integer
Example:
1
page_size
integer
Example:
10
total_elements
integer
Example:
7
total_pages
integer
Example:
1
GET
/projects/
{id}/rankingsGet the current rankings for a campaign across the projects supported ordered by project
Path variables
id
string
required
Request parameters
effective.start
number
optional
Start date time of the ranking
effective.end
number
optional
Responses
200
OK
Body
Object
content
Array
Object
rank
integer
Example:
1
contact
Object
id
string
alias
string
forename
string
surname
string
wallet
Object
id
string
alias
string
wallet_address
string
carbon
number
paging
Object
page_number
integer
Example:
1
page_size
integer
Example:
10
total_elements
integer
Example:
7
total_pages
integer
Example:
1
GET
/rankings
Get the current rankings for a campaign across the projects supported ordered by project
Request parameters
effective.start
number
optional
Start date time of the ranking
effective.end
number
optional
project_id
string
optional
Responses
200
OK
Body
Object
content
Array
Object
rank
integer
Example:
1
contact
Object
id
string
alias
string
forename
string
surname
string
wallet
Object
id
string
alias
string
wallet_address
string
project
Object
id
string
name
string
description
string
carbon
number
paging
Object
page_number
integer
Example:
1
page_size
integer
Example:
10
total_elements
integer
Example:
7
total_pages
integer
Example:
1
POST
/contacts
GET
/contacts/
{id}/wallets
GET
/contacts/
{id}/nftsNFT 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
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
project_id
string
optional
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
image
Single Image from Media Link
video
Single Video from Media Link
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": "MERCHANDISE",
"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"
}
],
"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
}
}
],
"paging": {
"page_number": 1,
"page_size": 10
},
"total_elements": 7,
"total_pages": 1
}
GET
/nfts/
{id}Path variables
id
string
required
Request body
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
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 attributes are defined with a product caaog. Once purchased they an instance of the product catalog is created as an NFT.
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
Family taken from the product catalog
Example:
Island Innovatoion
brand
string
brand taken
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
Example 1
GET /nfts/{id} HTTP/1.1
Content-Type: application/json
{
"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 Innovatoion",
"brand": ""
},
"blockchain": {
"token": {
"id": "",
"hash": "",
"uri": ""
},
"platform": "POLYGON",
"minted_date": ""
},
"collection": {
"id": "",
"name": ""
},
"owners": [
{
"id": "",
"wallet_id": "",
"contact": {
"id": "",
"name": ""
},
"ownership_start": 1,
"ownwership_end": ""
}
]
}
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
}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
}Generic Creatives Array
Object
id
string
Example:
0e02f4ab-797c-405c-8bf7-14651e28fe05
usage_type
string
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
Object
id
string
name
string
public_id
string
Example:
bg/v6z5d9dq7wktaqmm5nbm
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
attribute_type
string
Enumeration:
TEXT
NUMERIC
MEDIA
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
Creature / Animals including IUCN status and link
Object
id
string
Example:
b2c18354-3a6a-11ed-adf6-42010a9a000c
name
string
Example:
Polar Bear
description
string
Loss of Arctic sea ice due to climate change is the most serious threat to Polar Bears.
iucn_status
string
Enumeration:
NOT_EVALUATED
DATA_DEFICIENT
LEAST_CONCERN
NEAR_THREATENED
VULNERABLE
ENDANGERED
CRITICALLY_ENDANGERED
EXTINCT_WILD
EXTINCT
Example:
VULNERABLE
iucn_url
string
Example:
https://www.iucnredlist.org/species/22823/14871490#assessment-information
Ownership object
Object
id
string
wallet_id
Object
id
string
wallet_address
string
Example:
test2222
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
Object
id
string
Example:
b4c63cf9-69d0-46e5-a35a-b544077ff889
retirement_date
string
Example:
2022-10-04T12:28:09Z
serial_number
string
Example:
5570-246363874-246363878-VCU-024-MER-PE-14-985-08082013-07082014-1
carbon_inventory
Object
id
string
Example:
b863ad8f-40e3-11ed-adf6-42010a9a000c
name
string
Example:
Brazilian Rosewood Consignment
description
unknown
nullable
vintage
Object
name
string
Example:
2014
vintage_from
string
Example:
2014
vintage_to
unknown
nullable
unit_type
unknown
nullable
purchase_date
unknown
nullable
costs
Object
purchase_price
integer
Example:
20
currency
string
Example:
USD
blocks
integer
Example:
114
serial_number
string
Example:
4258-180357760-180357760-VCU-016-APX-ZW-14-902-01012012-30062012-1
supplier
Object
id
string
Example:
b9a5d84d-3112-11ed-adf6-42010a9a000c
verifier_reference
unknown
nullable
project
Object
id
string
name
string
description
string
account
Object
name
unknown
nullable
id
string
Example:
ec502490-3f14-11ed-adf6-42010a9a000c
beneficiary
Object
name
unknown
nullable
id
string
Example:
ec502490-3f14-11ed-adf6-42010a9a000c
certifications
unknown
nullable
reason
Object
id
string
Example:
ec502490-3f14-11ed-adf6-42010a9a000a
name
string
Example:
test
description
string
Example:
test
registry
Object
id
unknown
nullable
name
unknown
nullable
certificate_address
unknown
nullable
financials
Simple product schema for use in merchandising
Object
id
string
name
string
description
string
variants
Array
Object
id
string
Example:
254ee619-9606-11ea-a45f-42010a9a005d
sku
string
Example:
LATTE-01-PRIMO
barcode
string
Example:
1567890123
attributes
Array
Object
id
string
Example:
4649c3f3-95f7-11ea-a45f-42010a9a005d
variant_map
Object
id
string
Example:
640f62a8-95c0-11ea-a45f-42010a9a005d
name
string
Example:
Size
variant_value
string
Example:
Primo
creatives
creature
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
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
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": "MERCHANDISE",
"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
}
}Generic Creatives Array
Object
id
string
Example:
0e02f4ab-797c-405c-8bf7-14651e28fe05
usage_type
string
width
integer
Example:
259
format
string
Example:
jpg
media
Object
id
string
name
string
assets
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
Simple retirement object for use in events
Object
id
string
Example:
b4c63cf9-69d0-46e5-a35a-b544077ff889
retirement_date
string
Example:
2022-10-04T12:28:09Z
serial_number
string
Example:
5570-246363874-246363878-VCU-024-MER-PE-14-985-08082013-07082014-1
carbon_inventory
Object
id
string
Example:
b863ad8f-40e3-11ed-adf6-42010a9a000c
name
string
Example:
Brazilian Rosewood Consignment
description
string
vintage
Object
name
string
Example:
2014
vintage_from
string
Example:
2014
vintage_to
unknown
nullable
co2_kilogram_units
integer
Example:
114
unit_type
string
serial_number
string
Example:
4258-180357760-180357760-VCU-016-APX-ZW-14-902-01012012-30062012-1
registry
Object
id
string
registry
string
Enumeration:
VERRA
IHS-MARKIT
registry_id
string
Example:
1748
certificate_address
string
account
Object
id
string
name
string
beneficiary
Object
id
string
name
string
sponsor
Object
id
string
name
string
Events fired for NFT Minting
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
collection
Object
id
string
name
string
project
Object
retirement
owners
attributes
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": "",
"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": "",
"name": ""
},
"public_id": "bg/v6z5d9dq7wktaqmm5nbm"
},
"video": {
"id": "0e02f4ab-797c-405c-8bf7-14651e28fe05",
"usage_type": "",
"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": "",
"name": ""
},
"public_id": "bg/v6z5d9dq7wktaqmm5nbm"
},
"collection": {
"id": "",
"name": ""
},
"project": {
"id": "",
"name": "",
"description": "",
"sdg_goals": {
"id": "",
"sdg_goal": 1,
"name": "",
"description": ""
},
"creatures": [
{
"id": "b2c18354-3a6a-11ed-adf6-42010a9a000c",
"name": "Polar Bear",
"description": "",
"iucn_status": "VULNERABLE",
"iucn_url": "https://www.iucnredlist.org/species/22823/14871490#assessment-information"
}
],
"project_type": {
"id": "",
"name": ""
}
},
"retirement": {
"id": "b4c63cf9-69d0-46e5-a35a-b544077ff889",
"retirement_date": "2022-10-04T12:28:09Z",
"serial_number": "5570-246363874-246363878-VCU-024-MER-PE-14-985-08082013-07082014-1",
"carbon_inventory": {
"id": "b863ad8f-40e3-11ed-adf6-42010a9a000c",
"name": "Brazilian Rosewood Consignment",
"description": "",
"vintage": {
"name": "2014",
"vintage_from": "2014",
"vintage_to": null
},
"co2_kilogram_units": 114,
"unit_type": "",
"serial_number": "4258-180357760-180357760-VCU-016-APX-ZW-14-902-01012012-30062012-1"
},
"registry": {
"id": "",
"registry": "IHS-MARKIT",
"registry_id": "1748",
"certificate_address": ""
},
"account": {
"id": "",
"name": ""
},
"beneficiary": {
"id": "",
"name": ""
},
"sponsor": {
"id": "",
"name": ""
}
},
"owners": [
{
"id": "",
"wallet_id": "0x0fca20275697de6ebff30a293b3ceb21c003e972",
"organisation": {
"id": "",
"name": ""
},
"contact": {
"id": "",
"name": ""
},
"ownership_start": 1,
"ownership_end": 1,
"percentage": 1
}
],
"attributes": [
{
"id": "",
"name": "rarity",
"description": "",
"attribute_value": "Critically Endangered",
"lexicon": "nft.rarity",
"attribute_type": "MEDIA"
}
]
}
Object
event_id
string
Example:
0e5ad5f0-4e56-4299-bc4b-e794d486fcb4
created_on
number
Example:
1655905066.1341286
created_by
string
Example:
8f5ffe3b-a3cf-44e1-a8f1-d41a2fcb9311
tenant_id
string
Example:
e597dcbc-db49-44ce-b4f6-d20c14e0e46a
event_type
string
Example:
APPOINTMENT_SUCCESS
payload
Object
Event to drive blockchain minting for example
Object
event_id
string
Example:
0e5ad5f0-4e56-4299-bc4b-e794d486fcb4
created_on
number
Example:
1655905066.1341286
created_by
string
Example:
8f5ffe3b-a3cf-44e1-a8f1-d41a2fcb9311
tenant_id
string
Example:
e597dcbc-db49-44ce-b4f6-d20c14e0e46a
event_type
string
Example:
RETIREMENT
payload
Example 1
{
"event_id": "0e5ad5f0-4e56-4299-bc4b-e794d486fcb4",
"created_on": 1655905066.1341286,
"created_by": "8f5ffe3b-a3cf-44e1-a8f1-d41a2fcb9311",
"tenant_id": "e597dcbc-db49-44ce-b4f6-d20c14e0e46a",
"event_type": "RETIREMENT",
"payload": {
"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": "",
"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": "",
"name": ""
},
"public_id": "bg/v6z5d9dq7wktaqmm5nbm"
},
"video": {
"id": "0e02f4ab-797c-405c-8bf7-14651e28fe05",
"usage_type": "",
"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": "",
"name": ""
},
"public_id": "bg/v6z5d9dq7wktaqmm5nbm"
},
"collection": {
"id": "",
"name": ""
},
"project": {
"id": "",
"name": "",
"description": "",
"sdg_goals": {
"id": "",
"sdg_goal": 1,
"name": "",
"description": ""
},
"creatures": [
{
"id": "b2c18354-3a6a-11ed-adf6-42010a9a000c",
"name": "Polar Bear",
"description": "",
"iucn_status": "VULNERABLE",
"iucn_url": "https://www.iucnredlist.org/species/22823/14871490#assessment-information"
}
],
"project_type": {
"id": "",
"name": ""
}
},
"retirement": {
"id": "b4c63cf9-69d0-46e5-a35a-b544077ff889",
"retirement_date": "2022-10-04T12:28:09Z",
"serial_number": "5570-246363874-246363878-VCU-024-MER-PE-14-985-08082013-07082014-1",
"carbon_inventory": {
"id": "b863ad8f-40e3-11ed-adf6-42010a9a000c",
"name": "Brazilian Rosewood Consignment",
"description": "",
"vintage": {
"name": "2014",
"vintage_from": "2014",
"vintage_to": null
},
"co2_kilogram_units": 114,
"unit_type": "",
"serial_number": "4258-180357760-180357760-VCU-016-APX-ZW-14-902-01012012-30062012-1"
},
"registry": {
"id": "",
"registry": "VERRA",
"registry_id": "1748",
"certificate_address": ""
},
"account": {
"id": "",
"name": ""
},
"beneficiary": {
"id": "",
"name": ""
},
"sponsor": {
"id": "",
"name": ""
}
},
"owners": [
{
"id": "",
"wallet_id": {
"id": "",
"wallet_address": "test2222"
},
"organisation": {
"id": "",
"name": ""
},
"contact": {
"id": "",
"name": ""
},
"ownership_start": 1,
"ownership_end": 1,
"percentage": 1
}
],
"attributes": [
{
"id": "",
"name": "rarity",
"description": "",
"attribute_value": "Critically Endangered",
"lexicon": "nft.rarity",
"attribute_type": "TEXT"
}
]
}
}
Object
result
string
Example:
success
took
string
Example:
55.95
count
integer
Example:
28
collections
Array
Object
_id
string
Example:
63664d15458878365d2c9047
account
string
Example:
rEzbi191M5AjrucxXKZWbR5QeyfpbedBcV
name
string
Example:
Bored Apes XRP Club
family
string
slug
string
Example:
boredapesxrpclub
type
string
Example:
random
items
integer
Example:
9999
owners
integer
Example:
1558
private
string
Example:
no
logoImage
string
Example:
1667648789367_6e857d5bd55d454c9c63faaee522342f.png
featuredImage
string
Example:
1667648789369_da666ce0b40f4d1cb3549c35b6deef2a.png
bannerImage
string
Example:
1667744635837_5dfb643494324b56ba640c140c7bf916.png
spinnerImage
string
Example:
1667648789375_762c8a981d9449f2a72cc7a698e5f15f.gif
minterName
string
Example:
XRPNFT 3
costs
Array
Object
md5
string
Example:
f5d4749a1cd689532322fb595c3e1bd2
name
string
Example:
BAY
issuer
string
Example:
r4uq8urnYrT6LnZaadPyusyKCS68HVJtRn
currency
string
Example:
BAY
ext
string
Example:
jpg
exch
number
Example:
1116.9663269092596
supply
number
Example:
9995.953965568437
amount
string
Example:
1
description
string
Example:
The Bored Apes XRP Club is a group of 10,000 unique Bored Ape NFTs that reside on the XRP ledger. The Bored Apes XRP Club NFTs aren't just works of art. Your NFT serves as your Ape Club membership card, granting you access to members-only advantages. For additional information, go to www.x-apes.com.
created
integer
Example:
1667648789418
modified
integer
Example:
1667744635843
uuid
string
Example:
7051019ac1b84db3bb48cfc9948d2d15
taxon
integer
Example:
1
verified
string
Example:
yes
category
string
Example:
Collectables
floor
Object
issuer
string
Example:
XRPL
currency
string
Example:
XRP
amount
integer
Example:
650
volume
number
Example:
87153.7252
attrs
Array
Object
title
string
Example:
Background
items
Object
Punk Blue
integer
Example:
1099
Grey
integer
Example:
1028
Yellow
integer
Example:
1189
Sky Blue
integer
Example:
1113
Blue
integer
Example:
1007
Aquamarine
integer
Example:
1182
Army Green
integer
Example:
1112
Purple
integer
Example:
1131
Orange
integer
Example:
1139
totalVolume
number
Example:
1635104.295617
vol24h
integer
Object
success
boolean
Example:
true
data
Array
Object
contract
string
Example:
atomicassets
collection_name
string
Example:
metacarbon
name
string
Example:
Meta Carbon
img
string
Example:
QmavsjmkeYPe4Q7DgsYRvW73p3cugTVwSjhuvcp9fXnnM3
author
string
Example:
metacarbon
allow_notify
boolean
Example:
true
authorized_accounts
Array
Example:
["metacarbon","thomasherman"]
string
Example:
metacarbon
notify_accounts
Array
of
unknown
market_fee
number
Example:
0.06
data
Object
img
string
Example:
QmavsjmkeYPe4Q7DgsYRvW73p3cugTVwSjhuvcp9fXnnM3
url
string
Example:
https://meta-carbon.com
name
string
Example:
Meta Carbon
images
string
Example:
{"banner_1920x500":"QmSxaiZ2sy21DHf5ErBTH2BuFcH4Qf7KxVK51L3pkbSTRJ","logo_512x512":"QmavsjmkeYPe4Q7DgsYRvW73p3cugTVwSjhuvcp9fXnnM3"}
socials
string
Example:
{"twitter":"https://twitter.com/StandForTrees","medium":"https://medium.com/@CarbonCreature","facebook":"https://www.facebook.com/standfortrees","github":"","discord":"https://discord.com/invite/carbon-creatures","youtube":"https://www.youtube.com/c/StandForTreesNow","telegram":""}
description
string
Example:
Carbon offsetting technology is powered by [Meta Carbon](https://www.meta-carbon.com).
### The Vision
Meta Carbon has developed the world’s first web3 carbon offsetting platform that integrates into shopping carts and loyalty programs to provide carbon offsets, badges, and rewards using NFTs. We help brands engage their audience on the topic of climate change by making carbon offsetting engaging and transparent, by utilising blockchain. The Meta Carbon vision is to make offsetting so fun that everyone will want participate! The ambition is to save 100 million trees.
### The Partnership
This partnership enables AtomicHub.io to leverage Meta Carbon’s ability to include carbon offsetting at point of sale and add user engagement by issuing Prize NFTs to participants. The more carbon a user offsets the rarer the Prize NFT will be that they receive. Each month Meta Carbon will feature an endangered creature and everyone participating will receive a Prize NFT (Bronze to Platinum) depending on where they are on the monthly leaderboard.
Meta Carbon also manages and designs the user leader boards, the NFT creative, marketing materials and issues the NFTs. Meta Carbon’s ability to fractionalize carbon transactions down to one kilogram of carbon, just 2.5 cents, which makes it possible to expose carbon offsetting to the smallest of sales and a cost-conscious audience.
### Quality Carbon Projects
All traders on the AtomicHub.io platform will be given the opportunity to support Stand For Trees carbon development projects around the world with every transaction. This includes projects such as the Gola Rainforest in Sierra Leone, or the Rimba Raya Orangutan Reserve in Indonesia, and many others: Our Forests | Stand For Trees. You can see details of all the projects and the carbon leaderboard that makes it interactive and fun here: [https://wax.atomichub.io/green](https://wax.atomichub.io/green))
### About Meta Carbon Brands
Meta Carbon is a US-based technology company helping brands engage their audiences on the topic of climate change.
Meta Carbon’s NFTs are called Carbon Creatures which represent trees and endangered creatures threatened by the destruction of their habitat. Every NFT holds a certain amount of retired carbon. The first carbon backed NFT was sold in March 2021. Funds raised from Carbon Creatures NFT sales go to purchasing and retiring carbon offsets as well as supporting local charities and organizations that protect endangered animals and their habitats.
Meta Carbon operates, Stand for Trees ([https://www.standfortrees.org](https://www.standfortrees.org)), a nature-based carbon offsetting platform that has been offsetting carbon for 8 years. In the process saving over 3.5M mature trees. Stand For Trees has 15 quality REDD+ projects that protect some the world’s most crucial biodiverse forestry.
creator_info
string
Example:
{"country":"US","address":"148 Old Studio Rd","city":"New Canaan","zip":"06840","company":"Meta Carbon Inc.","name":"Thomas Herman","registration_number":"87-1759721"}
created_at_time
string
Example:
1667219194500
created_at_block
string
Example:
211513020
query_time
integer
Example:
1673454094194
Object
success
boolean
Example:
true
data
Array
Object
contract
string
Example:
atomicassets
template_id
string
Example:
648365
is_transferable
boolean
Example:
true
is_burnable
boolean
Example:
true
issued_supply
string
Example:
0
max_supply
string
Example:
50
collection
Object
collection_name
string
Example:
metacarbon
name
string
Example:
Meta Carbon
img
string
Example:
QmavsjmkeYPe4Q7DgsYRvW73p3cugTVwSjhuvcp9fXnnM3
author
string
Example:
metacarbon
allow_notify
boolean
Example:
true
authorized_accounts
Array
Example:
["metacarbon","thomasherman"]
string
Example:
metacarbon
notify_accounts
Array
of
unknown
market_fee
number
Example:
0.06
created_at_block
string
Example:
211513020
created_at_time
string
Example:
1667219194500
schema
Object
schema_name
string
Example:
creaturesv11
format
Array
Object
name
string
Example:
name
type
string
Example:
string
created_at_block
string
Example:
217584186
created_at_time
string
Example:
1670256983500
immutable_data
Object
img
string
Example:
QmPM1kx35UTBddELvC1nvDrMCcodvKr3HoKjS92H4c84mC
name
string
Example:
Hawksbill Turtle Silver: Atomic Hub Dec 2023
Creature Level
string
Example:
Silver
Creature Habitat
string
Example:
Ocean
Endangered Status
string
Example:
Endangered
Creature Description
string
Example:
This limited edition, Silver Hawksbill Turtle NFT on Wax allows you to flex your environmental and sustability creds right there in your NFT Collection. This turtle is a perfect addition to any ocean lover's collection. Expertly rendered, with intricate details and a realistic design, it captures the beauty and grace of this endangered species. Flex your committment to sustainability with this unique conversation starter. With only a limited number available, don't miss your chance to add the Hawksbill Turtle to your collection today!
created_at_time
string
Example:
1673381121500
created_at_block
string
Example:
223827869
name
string
Example:
Hawksbill Turtle Silver: Atomic Hub Dec 2023
query_time
integer
Example:
1673454251019
Object
success
boolean
Example:
true
data
Array
Object
contract
string
Example:
atomicassets
asset_id
string
Example:
1099839907732
owner
string
Example:
atomichub
is_transferable
boolean
is_burnable
boolean
Example:
true
collection
Object
collection_name
string
Example:
metacarbon
name
string
Example:
Meta Carbon
img
string
Example:
QmavsjmkeYPe4Q7DgsYRvW73p3cugTVwSjhuvcp9fXnnM3
author
string
Example:
metacarbon
allow_notify
boolean
Example:
true
authorized_accounts
Array
Example:
["metacarbon","thomasherman"]
string
Example:
metacarbon
notify_accounts
Array
of
unknown
market_fee
number
Example:
0.06
created_at_block
string
Example:
211513020
created_at_time
string
Example:
1667219194500
schema
Object
schema_name
string
Example:
co2offsetv11
format
Array
Object
name
string
Example:
name
type
string
Example:
string
created_at_block
string
Example:
211513948
created_at_time
string
Example:
1667219659000
template
Object
template_id
string
Example:
637981
max_supply
string
Example:
0
is_transferable
boolean
is_burnable
boolean
Example:
true
issued_supply
string
Example:
2
immutable_data
Object
img
string
Example:
QmWaZYCVfdLjfpMb4kyjkVYk2WoczArXSnBbRWHyCkDktn
name
string
Example:
CO2 Offset - Southern Cardamom
Project Name
string
Example:
Southern Cardamom
Project SDGs
string
Example:
1,2,3,4,5,6,8,9,10,11,12,13,15,16,17
Project Type
string
Example:
Green Carbon - Agriculture Forestry and Other Land Use
Project Location
string
Example:
Cambodia
Animals Protected
string
Example:
Elephant, Black & Sun bears, Pileated Gibbon, Loris, Leopard, Sunda Pangolin, Terrapin, and Giant Ibis
Project 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!
created_at_time
string
Example:
1670259938500
created_at_block
string
Example:
217590090
mutable_data
Object
immutable_data
Object
CO2 Offset More Info
string
Example:
https://carbon-creatures.com/offset/5beb825b-7329-11ed-aec0-42010a9a0004
CO2 Offset Amount (kg)
string
Example:
4000
CO2 Offset Beneficiary
string
Example:
AtomicHub
CO2 Offset Registry Link
string
Example:
https://mer.markit.com/br-reg/public/index.jsp?name=5beb825b-7329-11ed-aec0-42010a9a0004&entity=apiRetirement
CO2 Offset Serial Number
string
Example:
9881-155367883-155367886-VCS-VCU-263-VER-KH-14-1748-01012015-31122015-1
template_mint
string
Example:
2
backed_tokens
Array
of
unknown
burned_by_account
unknown
nullable
burned_at_block
unknown
nullable
burned_at_time
unknown
nullable
updated_at_block
string
Example:
217957967
updated_at_time
string
Example:
1670444210000
transferred_at_block
string
Example:
217957967
transferred_at_time
string
Example:
1670444210000
minted_at_block
string
Example:
217957967
minted_at_time
string
Example:
1670444210000
sales
Array
of
unknown
auctions
Array
of
unknown
prices
Array
of
unknown
data
Object
CO2 Offset More Info
string
Example:
https://carbon-creatures.com/offset/5beb825b-7329-11ed-aec0-42010a9a0004
CO2 Offset Amount (kg)
string
Example:
4000
CO2 Offset Beneficiary
string
Example:
AtomicHub
CO2 Offset Registry Link
string
Example:
https://mer.markit.com/br-reg/public/index.jsp?name=5beb825b-7329-11ed-aec0-42010a9a0004&entity=apiRetirement
CO2 Offset Serial Number
string
Example:
9881-155367883-155367886-VCS-VCU-263-VER-KH-14-1748-01012015-31122015-1
img
string
Example:
QmWaZYCVfdLjfpMb4kyjkVYk2WoczArXSnBbRWHyCkDktn
name
string
Example:
CO2 Offset - Southern Cardamom
Project Name
string
Example:
Southern Cardamom
Project SDGs
string
Example:
1,2,3,4,5,6,8,9,10,11,12,13,15,16,17
Project Type
string
Example:
Green Carbon - Agriculture Forestry and Other Land Use
Project Location
string
Example:
Cambodia
Animals Protected
string
Example:
Elephant, Black & Sun bears, Pileated Gibbon, Loris, Leopard, Sunda Pangolin, Terrapin, and Giant Ibis
Project 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!
name
string
Example:
CO2 Offset - Southern Cardamom
query_time
integer
Example:
1673454398803
GET
/self-service/transactions
Request parameters
wallet_id
string
optional
contact_id
string
optional
transaction_date.start
string
optional
transaction_date.end
string
optional
Responses
200
OK
Body
Object
id
string
Example:
d7b09a29-93d4-430f-880c-03e2263f55b8
transaction_date
integer
Example:
1701775329
reference
string
Example:
500kg CO2 - Kasigau Wildlife Sanctuary
base_currency
Object
amount
integer
Example:
10
currency
string
Example:
USD
wallet
Object
id
string
Example:
76b23410-07c2-11ee-b1d8-42010a9a0004
alias
string
Example:
sam.b**s
wallet_address
string
Example:
sam.b**s
contact
Object
name
string
Example:
Sam Bugas
id
string
Example:
f62bf311-07c1-11ee-b1d8-42010a9a0004
co2_kg_units
integer
Example:
500
tx_id
string
Example:
37009-wc_order_GGe6SznL0viIY-100000000000677
project
Object
name
string
Example:
Kasigau Wildlife Sanctuary
id
string
Example:
6015d167-4ed8-11ed-aec0-42010a9a0004
campaign
Object
name
string
Example:
Stand For Trees Q4
id
string
Example:
bab088f5-7d90-11ee-aa28-42010a9a0006
retirement
Object
id
string
Example:
81148655-3bcf-4111-5d7c-ea3d1d1282b5
serial_number
string
Example:
13113-472043548-472043583-VCS-VCU-261-VER-PE-14-1067-01072010-30062011-1
units
integer
Example:
36000
unit_type
string
Example:
VCU
offset_url
string
Example:
https://registry.verra.org/myModule/rpt/myrpt.asp?r=206&h=218506
subscription
Object
id
unknown
nullable
subscription_item
Object
id
unknown
nullable