---
agentTools:
  projectIndex: https://imx.readme.io/llms.txt
---

# Get a list of collections

Get a list of collections

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Immutable X API",
    "version": "1.0",
    "description": "https://docs.x.immutable.com/reference",
    "contact": {
      "name": "Immutable",
      "url": "https://godsunchained.com"
    }
  },
  "servers": [
    {
      "url": "https://api.x.immutable.com",
      "description": "Production Environment"
    },
    {
      "url": "https://api.ropsten.x.immutable.com",
      "description": "Ropsten Environment"
    }
  ],
  "paths": {
    "/v1/collections": {
      "get": {
        "summary": "Get a list of collections",
        "tags": [
          "collections"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CollectionList"
                }
              }
            }
          }
        },
        "operationId": "getCollections",
        "parameters": [
          {
            "$ref": "#/components/parameters/page_size"
          },
          {
            "$ref": "#/components/parameters/cursor"
          },
          {
            "$ref": "#/components/parameters/order_by"
          },
          {
            "$ref": "#/components/parameters/direction"
          },
          {
            "schema": {
              "type": "string"
            },
            "in": "query",
            "name": "blacklist",
            "description": "List of collections not to be displayed, separated by commas"
          }
        ],
        "description": "Get a list of collections"
      }
    }
  },
  "components": {
    "schemas": {
      "Collection": {
        "description": "",
        "type": "object",
        "properties": {
          "address": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "description": {
            "type": "string",
            "minLength": 1
          },
          "icon_url": {
            "type": "string",
            "minLength": 1
          },
          "collection_image_url": {
            "type": "string",
            "minLength": 1
          },
          "project_id": {
            "type": "number"
          },
          "metadata_api_url": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "address",
          "name",
          "description",
          "icon_url",
          "collection_image_url",
          "project_id",
          "metadata_api_url"
        ],
        "x-examples": {
          "example-1": {
            "address": "0xdca591473c072ed56a3107b3c183580c0ab3724a",
            "name": "Ganesh! Enabler of success.",
            "description": "Ganesh! Enabler of success.",
            "icon_url": "https://gateway.pinata.cloud/ipfs/QmfXozM6nP14wXBYYbC7iAr2HJiEpDVJNqt8bFzDKLwWJL",
            "collection_image_url": "https://gateway.pinata.cloud/ipfs/QmfXozM6nP14wXBYYbC7iAr2HJiEpDVJNqt8bFzDKLwWJL",
            "project_id": 1727,
            "metadata_api_url": "https://gateway.pinata.cloud/ipfs/Qmcy5iVaw1PBTf1w39hCh2pc5fhcBGizeUMk5y9jE81yPW"
          }
        }
      },
      "CollectionList": {
        "description": "",
        "type": "object",
        "x-examples": {
          "example-1": {
            "result": [
              {
                "address": "0x4066fe591646710432449757c513c2d4aa8b954e",
                "name": "CCFairy Collection 2201",
                "description": "CCFairy Collection Desc",
                "icon_url": "https://cloudfront-us-east-2.images.arcpublishing.com/reuters/43YAWLITTZJLZIQTCP2JSS4KSM.jpg",
                "collection_image_url": "https://cloudfront-us-east-2.images.arcpublishing.com/reuters/43YAWLITTZJLZIQTCP2JSS4KSM.jpg",
                "project_id": 1738,
                "metadata_api_url": "https://ipfs.io/ipfs/QmRUvD8MfCZ4VnNjH5Vs5NcAyiHyHH3KW5CHE7pCkDao4d"
              }
            ],
            "cursor": "eyJhZGRyZXNzIjoiMHg0MDY2ZmU1OTE2NDY3MTA0MzI0NDk3NTdjNTEzYzJkNGFhOGI5NTRlIiwiY3JlYXRlZF9hdCI6IjIwMjItMDEtMDNUMDI6MTQ6MzcuNDY5MTUyWiIsIkNvbGxlY3Rpb25JbWFnZVVybCI6Imh0dHBzOi8vY2xvdWRmcm9udC11cy1lYXN0LTIuaW1hZ2VzLmFyY3B1Ymxpc2hpbmcuY29tL3JldXRlcnMvNDNZQVdMSVRUWkpMWklRVENQMkpTUzRLU00uanBnIiwicHJvamVjdF9pZCI6MTczOCwibWV0YWRhdGFfYXBpX3VybCI6Imh0dHBzOi8vaXBmcy5pby9pcGZzL1FtUlV2RDhNZkNaNFZuTmpINVZzNU5jQXlpSHlISDNLVzVDSEU3cENrRGFvNGQifQ",
            "remaining": 1
          }
        },
        "properties": {
          "result": {
            "type": "array",
            "uniqueItems": true,
            "minItems": 1,
            "items": {
              "$ref": "#/components/schemas/Collection"
            }
          },
          "cursor": {
            "type": "string",
            "minLength": 1
          },
          "remaining": {
            "type": "number"
          }
        },
        "required": [
          "result",
          "cursor",
          "remaining"
        ]
      }
    },
    "parameters": {
      "page_size": {
        "name": "page_size",
        "in": "query",
        "required": false,
        "schema": {
          "type": "integer"
        },
        "description": "Page size of the result"
      },
      "cursor": {
        "name": "cursor",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string"
        },
        "description": "Cursor"
      },
      "order_by": {
        "name": "order_by",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string"
        },
        "description": "Property to sort by"
      },
      "direction": {
        "name": "direction",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string"
        },
        "description": "Direction to sort (asc/desc)"
      }
    }
  },
  "tags": [
    {
      "name": "collections"
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 97,
      "1": 222,
      "2": 73,
      "3": 4,
      "4": 47,
      "5": 148,
      "6": 195,
      "7": 0,
      "8": 100,
      "9": 250,
      "10": 119,
      "11": 107
    }
  }
}
```