Skip to main content

ConsenSys NFT Public API (v1)

Download OpenAPI specification:Download

Get known contract capabilities

Responses

Response samples

Content type
application/json
{
  • "cursor": null,
  • "has_more": true,
  • "results": [
    ],
  • "total_results": 0
}

Get the Application Binary Interface (ABI) for a specific capability

path Parameters
capability
required
string

Responses

Response samples

Content type
application/json
{
  • "abi": [
    ],
  • "name": "string"
}

Get all collections by an organization

query Parameters
limit
number [ 1 .. 100 ]
Default: 100

PaginationLimit

order_direction
string
Default: null
Enum: "ASC" "DESC" null
cursor
string
Default: null

SafeString

organization_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "cursor": null,
  • "has_more": true,
  • "results": [
    ],
  • "total_results": 0
}

Get a public collection by collection id

path Parameters
collection_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string"
}

Get metadata for a specific token in a collection

path Parameters
collection_id
required
string <uuid>
token_id
required
string

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "properties": null
}

Get collection stats

path Parameters
collection_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "attributes": [
    ],
  • "excluded": [
    ],
  • "tokens_indexed": 0
}

Get global contract addresses.

query Parameters
limit
number [ 1 .. 100 ]
Default: 100

PaginationLimit

order_direction
string
Default: null
Enum: "ASC" "DESC" null
cursor
string
Default: null

SafeString

network_ids
required
Array of integers <int32> [ items <int32 > ]

Responses

Response samples

Content type
application/json
{
  • "cursor": null,
  • "has_more": true,
  • "results": [
    ],
  • "total_results": 0
}

Get the item that is redeemable for the given claim token

path Parameters
claim_token
required
string

Responses

Response samples

Content type
application/json
{
  • "is_active": true,
  • "is_claimed": true,
  • "item": {
    },
  • "quantity": 0,
  • "voucher": null
}

Redeems an email claim based on the claim token and pincode

If the tx_payer is SELLER, the token is immediately transferred to the buyer. If the tx_payer is BUYER, a mint voucher is returned.

path Parameters
claim_token
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "voucher": null
}

Sends a pincode to the email address to verify the claim

path Parameters
claim_token
required
string

Responses

Response samples

Content type
application/json
{
  • "attributes": {
    },
  • "collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "listing": null,
  • "media": {
    },
  • "token_contract": {
    },
  • "token_id": "string"
}

Get all public items from an organization

query Parameters
limit
number [ 1 .. 100 ]
Default: 100

PaginationLimit

order_direction
string
Default: null
Enum: "ASC" "DESC" null
cursor
string
Default: null

SafeString

organization_id
required
string <uuid>
network_ids
Array of integers <int32> [ items <int32 > ]
Default: null
attributes
Array of strings
Default: null
collection_ids
Array of strings <uuid>
Default: null

Responses

Response samples

Content type
application/json
{
  • "cursor": null,
  • "has_more": true,
  • "results": [
    ],
  • "total_results": 0
}

Get a public item by id

path Parameters
item_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "attributes": {
    },
  • "collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",
  • "contract_address": null,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "media": {
    },
  • "network_id": 0,
  • "token_id": "string",
  • "token_type": "string"
}

Get item history

path Parameters
item_id
required
string <uuid>
query Parameters
limit
number [ 1 .. 100 ]
Default: 100

PaginationLimit

order_direction
string
Default: null
Enum: "ASC" "DESC" null
cursor
string
Default: null

SafeString

event_type
string
Default: null
Enum: "MINT" "TRANSFER" "BURN" null

Responses

Response samples

Content type
application/json
{
  • "cursor": null,
  • "has_more": true,
  • "results": [
    ],
  • "total_results": 0
}

Get item owners.

path Parameters
item_id
required
string <uuid>
query Parameters
limit
number [ 1 .. 100 ]
Default: 100

PaginationLimit

order_direction
string
Default: null
Enum: "ASC" "DESC" null
cursor
string
Default: null

SafeString

Responses

Response samples

Content type
application/json
{
  • "cursor": null,
  • "has_more": true,
  • "results": [
    ],
  • "total_results": 0
}

Get listings for the given organization

query Parameters
limit
number [ 1 .. 100 ]
Default: 100

PaginationLimit

order_direction
string
Default: null
Enum: "ASC" "DESC" null
cursor
string
Default: null

SafeString

organization_id
required
string <uuid>
item_id
string <uuid>
Default: null
collection_id
string <uuid>
Default: null

Responses

Response samples

Content type
application/json
{
  • "cursor": null,
  • "has_more": true,
  • "results": [
    ],
  • "total_results": 0
}

Get Listing for the given listing id

path Parameters
listing_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "collection_id": null,
  • "currency": "string",
  • "end_time": null,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "item_id": null,
  • "max_quantity_per_tx": 0,
  • "payment_providers": [
    ],
  • "price": "string",
  • "quantity_listed": 0,
  • "quantity_remaining": 0,
  • "start_time": null
}

Get the available networks

query Parameters
limit
number [ 1 .. 100 ]
Default: 100

PaginationLimit

order_direction
string
Default: null
Enum: "ASC" "DESC" null
cursor
string
Default: null

SafeString

Responses

Response samples

Content type
application/json
{
  • "cursor": null,
  • "has_more": true,
  • "results": [
    ],
  • "total_results": 0
}

Create a purchase intent

The purchase intent can be made with any provider configured for the listing. The provider must be one of the following: STRIPE, MINT_VOUCHER, COINBASE. The response data will have provider specific data in the data field.

Request Body schema: application/json
required
object
listing_id
required
string <uuid>
provider
required
string
quantity
required
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "buyer": {
    },
  • "listing_id": "5322d4a9-51d2-4408-82fb-01ffecfb8304",
  • "provider": "string",
  • "quantity": 0
}

Response samples

Content type
application/json
{
  • "data": null,
  • "expires_at": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Request a cancel of a purchase intent for a given purchase intent id.

path Parameters
purchase_intent_id
required
string <uuid>

Responses

Get payment tokens available for the given networks

query Parameters
limit
number [ 1 .. 100 ]
Default: 100

PaginationLimit

order_direction
string
Default: null
Enum: "ASC" "DESC" null
cursor
string
Default: null

SafeString

network_id
required
Array of numbers[ items >= 0 ]

Responses

Response samples

Content type
application/json
{
  • "cursor": null,
  • "has_more": true,
  • "results": [
    ],
  • "total_results": 0
}