Sign in

v1

latestOpenAPI 3.0.12026-07-2699111970.1 KB
IP Story Protocol

Get a Collection

Get a collection by its id deployed on the Story chain

API scope required: collections.read

get/v1/ip/collections/{collectionId}

Path parameters

collectionIdstring required

Headers

X-API-KEYstring required

API key required for authentication

Response

SPG Collection found

idstring required

The id of the collection

actionIdstring required

The action id of the collection

Example response

{
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "actionId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "metadata": {
    "name": "My Collection",
    "symbol": "MYCOL",
    "description": "My Collection Description",
    "image": "https://example.com/image.png"
  },
  "onChain": {
    "chain": "story-testnet",
    "contractAddress": "0x123",
    "explorerLink": "https://portal.story.foundation/collections/0xAC6062FF53fa41e61Fe01B89B83d9dB96b5F9280"
  }
}