Skip to main content
GET
/
v1
/
ip
/
collections
/
{collectionId}
Get a Collection
curl --request GET \
  --url https://staging.crossmint.com/api/v1/ip/collections/{collectionId} \
  --header 'X-API-KEY: <x-api-key>'
import requests

url = "https://staging.crossmint.com/api/v1/ip/collections/{collectionId}"

headers = {"X-API-KEY": "<x-api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-API-KEY': '<x-api-key>'}};

fetch('https://staging.crossmint.com/api/v1/ip/collections/{collectionId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://staging.crossmint.com/api/v1/ip/collections/{collectionId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <x-api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://staging.crossmint.com/api/v1/ip/collections/{collectionId}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("X-API-KEY", "<x-api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://staging.crossmint.com/api/v1/ip/collections/{collectionId}")
.header("X-API-KEY", "<x-api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://staging.crossmint.com/api/v1/ip/collections/{collectionId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<x-api-key>'

response = http.request(request)
puts response.read_body
{
  "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"
  }
}
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

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

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