Get collection list

GET

collections

curl --request GET \
  --url https://api.oneofnone.io/v1/collections \
  --header 'x-api-key: <api-key>'

{
  "data": [
    {
      "id": 123,
      "name": "<string>",
      "type": "<string>",
      "description": "<string>",
      "quantity": 123,
      "status": "ACTIVE",
      "slug": "<string>",
      "keywords": [
        "<string>"
      ],
      "redirect_url": "<string>",
      "store_url": "<string>",
      "purchase_url": "<string>",
      "image": {
        "url": "<string>"
      },
      "video": {
        "url": "<string>",
        "poster_url": "<string>"
      },
      "model": {
        "url": "<string>"
      },
      "share_image": {
        "url": "<string>"
      },
      "gallery": [
        {
          "alt": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "description": "<string>",
          "file_type": "<string>",
          "id": 123,
          "poster_url": "<string>",
          "size": 123,
          "tags": [
            "<string>"
          ],
          "thumbnail_url": "<string>",
          "updated_at": "2023-11-07T05:31:56Z",
          "url": "<string>",
          "order": 123,
          "variants": [
            "<string>"
          ],
          "type": "<string>"
        }
      ],
      "chain": "ETH",
      "contract": {
        "address": "<string>",
        "standard": "<string>"
      },
      "product_registration": true,
      "product_name_template": "<string>",
      "drop_date": "2023-11-07T05:31:56Z",
      "drop_price": 123,
      "drop_currency": "ETH",
      "attributes": {},
      "variants": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "next": "<string>",
    "prev": "<string>",
    "limit": 123,
    "offset": 123
  }
}

Authorizations

x-api-key

string

header

required

The API key required for accessing protected routes. It should be included in the request headers as x-api-key.

Query Parameters

status

enum<string>

The status of the collections to filter by.

Available options:

ACTIVE,

DRAFT,

INACTIVE

chain

enum<string>

The blockchain to filter collections by.

Available options:

ETH,

POLY,

BASE

min_quantity

integer

The minimum number of products in the collection.

Required range: x >= 1

max_quantity

integer

The maximum number of products in the collection.

Required range: x >= 1

min_drop_price

number

The minimum price for products in the collection.

Required range: x >= 1

max_drop_price

number

The maximum price for products in the collection.

Required range: x >= 1

limit

integer

The maximum number of items to return (1-1000).

Required range: 1 <= x <= 1000

offset

integer

The number of items to skip before starting to collect the result set.

order

enum<string>

The sort order of the results.

Available options:

asc,

desc

order_by

string

The field by which to order the results.

Response

200

application/json

Successfully retrieved collections.

data

object[]

data.id

integer

The unique identifier of the collection.

data.name

string

The name of the collection.

data.type

string | null

The type of the collection.

data.description

string | null

The description of the collection.

data.quantity

integer | null

The quantity of items in the collection.

data.status

enum<string> | null

The status of the collection.

Available options:

ACTIVE,

DRAFT,

PENDING_APPROVAL,

ARCHIVED

data.slug

string | null

The slug of the collection.

data.keywords

string[] | null

Keywords associated with the collection.

data.redirect_url

string | null

Redirect URL for the collection.

data.store_url

string | null

Store URL for the collection.

data.purchase_url

string | null

Purchase URL for the collection.

data.image

object

data.video

object | null

data.model

object | null

data.gallery

object[] | null

The gallery items related to the collection.

data.chain

enum<string> | null

The blockchain chain of the collection.

Available options:

ETH,

POLY,

BASE,

ETH_SEPOLIA,

BASE_SEPOLIA,

POLY_AMOY,

OP

data.contract

object | null

data.product_registration

boolean | null

Indicates whether product registration is required.

data.product_name_template

string | null

Template for the product name.

data.drop_date

string | null

The drop date of the collection.

data.drop_price

number | null

The drop price of the collection.

data.drop_currency

enum<string> | null

The currency used for the drop price.

Available options:

ETH,

USD,

USDC,

EUR,

GBP,

MATIC,

SOL

data.attributes

object | null

Additional attributes of the collection.

data.variants

object | null

Variants of the collection.

data.created_at

string

The timestamp when the collection was created.

data.updated_at

string | null

The timestamp when the collection was last updated.

pagination

object

Fetch vault analytics Get collection

curl --request GET \
  --url https://api.oneofnone.io/v1/collections \
  --header 'x-api-key: <api-key>'

{
  "data": [
    {
      "id": 123,
      "name": "<string>",
      "type": "<string>",
      "description": "<string>",
      "quantity": 123,
      "status": "ACTIVE",
      "slug": "<string>",
      "keywords": [
        "<string>"
      ],
      "redirect_url": "<string>",
      "store_url": "<string>",
      "purchase_url": "<string>",
      "image": {
        "url": "<string>"
      },
      "video": {
        "url": "<string>",
        "poster_url": "<string>"
      },
      "model": {
        "url": "<string>"
      },
      "share_image": {
        "url": "<string>"
      },
      "gallery": [
        {
          "alt": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "description": "<string>",
          "file_type": "<string>",
          "id": 123,
          "poster_url": "<string>",
          "size": 123,
          "tags": [
            "<string>"
          ],
          "thumbnail_url": "<string>",
          "updated_at": "2023-11-07T05:31:56Z",
          "url": "<string>",
          "order": 123,
          "variants": [
            "<string>"
          ],
          "type": "<string>"
        }
      ],
      "chain": "ETH",
      "contract": {
        "address": "<string>",
        "standard": "<string>"
      },
      "product_registration": true,
      "product_name_template": "<string>",
      "drop_date": "2023-11-07T05:31:56Z",
      "drop_price": 123,
      "drop_currency": "ETH",
      "attributes": {},
      "variants": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "next": "<string>",
    "prev": "<string>",
    "limit": 123,
    "offset": 123
  }
}

Access

Activities

Analytics

Collections

Products

Metadata

Authorizations

Query Parameters

Response