---
updatedAt: 2025-11-12T01:02:06.000Z
agentTools:
  projectIndex: https://docs.blockberry.one/llms.txt
---

# getCollections

Get a list of all NFT collections on the Iota Network.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Iota mainnet API",
    "description": "The Iota Blockchain API is used to retrieve Iota Blockchain data. In order to execute queries you need to get API Key and use it in header 'x-api-key'. However, before that you need to sign up on the explorer or company website. If an account is created on the website <strong>https://staketab.com/</strong> or <strong>https://suiscan.xyz/</strong>, the user will be granted the <strong>ROLE_USER</strong> role. After that you may fetch API KEY.",
    "termsOfService": "terms-of-service",
    "contact": {
      "name": "Staketab tech support",
      "url": "https://staketab.com/",
      "email": "support@staketab.com"
    },
    "license": {
      "name": "Apache 2.0",
      "url": "https://www.apache.org/licenses/LICENSE-2.0"
    },
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://api.blockberry.one/iota-testnet",
      "description": "Production"
    }
  ],
  "security": [
    {
      "x-api-key": []
    }
  ],
  "paths": {
    "/v1/collections": {
      "get": {
        "tags": [
          "NFTs"
        ],
        "summary": "getCollections",
        "description": "Get a list of all NFT collections on the Iota Network.",
        "operationId": "getCollections",
        "parameters": [
          {
            "name": "page",
            "in": "query",
            "description": "Queried API page.",
            "required": true,
            "schema": {
              "minimum": 0,
              "type": "integer",
              "format": "int32",
              "default": 0
            }
          },
          {
            "name": "size",
            "in": "query",
            "description": "Number of queried entries.",
            "required": true,
            "schema": {
              "maximum": 50,
              "minimum": 1,
              "type": "integer",
              "format": "int32",
              "default": 20
            }
          },
          {
            "name": "orderBy",
            "in": "query",
            "description": "Sorting method: from the lowest element to the highest (ASC) or from the highest element to the lowest (DESC).",
            "required": true,
            "schema": {
              "type": "string",
              "default": "DESC",
              "enum": [
                "ASC",
                "DESC"
              ]
            }
          },
          {
            "name": "sortBy",
            "in": "query",
            "description": "Select sorting parameter.",
            "required": true,
            "schema": {
              "type": "string",
              "description": "Select sorting parameter.",
              "default": "AGE",
              "enum": [
                "AGE",
                "NAME",
                "ITEMS",
                "VOLUME",
                "HOLDER"
              ]
            }
          },
          {
            "name": "period",
            "in": "query",
            "description": "Select calculation period.",
            "required": true,
            "schema": {
              "type": "string",
              "description": "Select calculation period.",
              "default": "DAY",
              "enum": [
                "DAY",
                "WEEK",
                "MONTH"
              ]
            }
          },
          {
            "name": "searchStr",
            "in": "query",
            "description": "Enter part or full collection name or id to get the queried collection.",
            "required": false,
            "schema": {
              "type": "string",
              "default": ""
            },
            "example": "Captain Leapfrog"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/PageCollectionDtoAPI"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "PageableObject": {
        "type": "object",
        "properties": {
          "pageNumber": {
            "type": "integer",
            "format": "int32"
          },
          "pageSize": {
            "type": "integer",
            "format": "int32"
          },
          "offset": {
            "type": "integer",
            "format": "int64"
          },
          "sort": {
            "$ref": "#/components/schemas/SortObject"
          },
          "paged": {
            "type": "boolean"
          },
          "unpaged": {
            "type": "boolean"
          }
        }
      },
      "SortObject": {
        "type": "object",
        "properties": {
          "sorted": {
            "type": "boolean"
          },
          "empty": {
            "type": "boolean"
          },
          "unsorted": {
            "type": "boolean"
          }
        }
      },
      "CollectionDtoAPI": {
        "type": "object",
        "properties": {
          "collectionType": {
            "type": "string"
          },
          "collectionName": {
            "type": "string"
          },
          "collectionImg": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "securityMessage": {
            "type": "string"
          },
          "projectSecurityMessage": {
            "type": "string"
          },
          "packageId": {
            "type": "string"
          },
          "packageName": {
            "type": "string"
          },
          "projectName": {
            "type": "string"
          },
          "projectImg": {
            "type": "string"
          },
          "creatorAddress": {
            "type": "string"
          },
          "creatorName": {
            "type": "string"
          },
          "creatorImg": {
            "type": "string"
          },
          "creatorSecurityMessage": {
            "type": "string"
          },
          "socialWebsite": {
            "type": "string"
          },
          "nftsCount": {
            "type": "integer",
            "format": "int64"
          },
          "latestPrice": {
            "type": "number"
          },
          "volume": {
            "type": "number"
          },
          "holdersCount": {
            "type": "integer",
            "format": "int64"
          },
          "marketplaces": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "createTimestamp": {
            "type": "integer",
            "format": "int64"
          }
        }
      },
      "PageCollectionDtoAPI": {
        "type": "object",
        "properties": {
          "totalPages": {
            "type": "integer",
            "format": "int32"
          },
          "totalElements": {
            "type": "integer",
            "format": "int64"
          },
          "size": {
            "type": "integer",
            "format": "int32"
          },
          "content": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CollectionDtoAPI"
            }
          },
          "number": {
            "type": "integer",
            "format": "int32"
          },
          "sort": {
            "$ref": "#/components/schemas/SortObject"
          },
          "numberOfElements": {
            "type": "integer",
            "format": "int32"
          },
          "pageable": {
            "$ref": "#/components/schemas/PageableObject"
          },
          "first": {
            "type": "boolean"
          },
          "last": {
            "type": "boolean"
          },
          "empty": {
            "type": "boolean"
          }
        }
      }
    },
    "securitySchemes": {
      "x-api-key": {
        "type": "apiKey",
        "name": "x-api-key",
        "in": "header"
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```