Get Collections

The endpoint "Get Collections " allows you to retrieve the project data associated with a specific studio address, project and chain.

Overview

Endpoint

• Method: GET

• URL: /collections?chain={chain}&project={projectId}&studioAddress={studioAddress}

Responses

Success (Code 200)

{
  [
   {
      "address": "0x8a63860fF851bb1391a295dF717a3bD210eB2170",
      "name": "Desc",
      "symbol": "123",
      "description": "LL",
      "image": "https://xerial-main-bucket.s3.us-east-1.amazonaws.com/287b86e8de6d472910015e048b04d08bc4a721aabb3e20651442c3a3c7946f94-anime%20armor.jpg",
      "externalUrl": "http://external-url.com",
      "chain": "polygon",
      "txHash": "0x11bb4d5fadbb9f6ab1b0d1be1bb50c52a5ac997c495e8e29131629e21774e06a",
      "project": "6564b4f3fa203b9Klsa2Ju7d0",
      "id": "6585de73487f1429cb10bcb9"
    },
    {
      "address": "0x11FF517B5e01fd22148F085FcA04F707d5b6e4DC",
      "name": "DS",
      "symbol": "23",
      "description": "Description",
      "image": "https://xerial-main-bucket.s3.us-east-1.amazonaws.com/2940477b2bead3482008d9be12f37a6b0c4f2372d47104a322be3e7e59f31e18-tanjiro.jpg",
      "externalUrl": "http://external-url.com",
      "chain": "polygon",
      "txHash": "0x83a2d2ec69755693cc98766cd3ac1c9a697beec45aa8496a2bddba3d27ee7f7c",
      "project": "6564b4f3fa203b9Klsa2Ju7d0",
      "id": "6585deb8487f1429cb10bcdc"
    }
  ]
}

• Media Type: application/json

• Example Value: An object containing the response for the collection data.

Usage

1. Send a GET request to the /api.xerial.io/collections endpoint using the desired URL queries to filtter the collections data.

2. Handle the response accordingly based on success, unauthorized access, forbidden access, not found, method not allowed, precondition failed, or internal server error.

Note: Ensure to get the studio address from your dashboard.