Skip to main content

API Spec

ChainSafe Marketplace API (1.19.2)

Download OpenAPI specification:Download

Items

This section lists all the APIs related to marketplace items.

Get Project Items

Get all the items for a project. You can provide various filters to get the items you want.

path Parameters
projectID
required
string

Project ID

query Parameters
chainId
required
string

Chain ID

tokenContractAddress
string

Token Contract Address

status
string (item_status)
Enum: "sold" "listed" "canceled"

Status of the item

sortBy
string (item_sort_by)
Enum: "listed_at" "price"

Sort by

sortOrder
string (item_sort_order)
Enum: "asc" "desc"

Sort order

cursor
string

pagination cursor

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Marketplace Items

Get all the items for a project under a marketplace.

path Parameters
projectID
required
string

Project ID

marketplaceID
required
string

Marketplace ID

query Parameters
tokenContractAddress
string

Token Contract Address

status
string (item_status)
Enum: "sold" "listed" "canceled"

Status of the item

sortBy
string (item_sort_by)
Enum: "listed_at" "price"

Sort by

sortOrder
string (item_sort_order)
Enum: "asc" "desc"

Sort order

cursor
string

pagination cursor

Responses

Response samples

Content type
application/json
{
  • "page_number": 0,
  • "page_size": 0,
  • "total": 0,
  • "cursor": "string",
  • "items": [
    ]
}

Get Item

Get specific Item for a project under a marketplace.

path Parameters
projectID
required
string

Project ID

marketplaceID
required
string

Marketplace ID

itemID
required
string

Item ID

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "chain_id": "string",
  • "project_id": "string",
  • "marketplace_id": "string",
  • "token": {
    },
  • "marketplace_contract_address": "string",
  • "seller": "string",
  • "buyer": "string",
  • "price": "string",
  • "listed_at": 0,
  • "status": "sold"
}