Get IP Collection

Get a collection by its id deployed on the Story chain

API scope required: collections.read

GET /v1/ip/collections/{collectionId}

Get a Collection

cURL

curl --request GET \
  --url https://staging.crossmint.com/api/v1/ip/collections/{collectionId} \
  --header 'X-API-KEY: <x-api-key>'

200

{
  "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"
  }
}

This API is still under development. Contact support for early access.

Headers

X-API-KEY · string · required

API key required for authentication

Path Parameters

collectionId · string · required

Response

200 - application/json

SPG Collection found

Story Protocol collection creation output

id · string · required

The id of the collection

Example:

"d290f1ee-6c54-4b01-90e6-d701748f0851"

actionId · string · required

The action id of the collection

Example:

"d290f1ee-6c54-4b01-90e6-d701748f0851"

metadata · object · required

Story Protocol collection metadata response

Show child attributes

Example:

{
  "name": "My Collection",
  "symbol": "MYCOL",
  "description": "My Collection Description",
  "image": "https://example.com/image.png"
}

onChain · object · required

Show child attributes