Skip to main content
GET
/
2022-06-09
/
collections
/
Get All Collections
curl --request GET \
  --url https://staging.crossmint.com/api/2022-06-09/collections/ \
  --header 'X-API-KEY: <api-key>'
import requests

url = "https://staging.crossmint.com/api/2022-06-09/collections/"

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

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

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

fetch('https://staging.crossmint.com/api/2022-06-09/collections/', 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/2022-06-09/collections/",
  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: <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/2022-06-09/collections/"

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

	req.Header.Add("X-API-KEY", "<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/2022-06-09/collections/")
  .header("X-API-KEY", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://staging.crossmint.com/api/2022-06-09/collections/")

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

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

response = http.request(request)
puts response.read_body
{
  "results": [
    {
      "id": "bb691876-edb3-404c-af3e-c019b8e2ed2c",
      "metadata": {
        "name": "Test Collection",
        "description": "Test",
        "imageUrl": "ipfs://QmVocoiYXZLAtheEHV3VF8w4pa68bkPutT8cQZdMrrpzxh",
        "symbol": "XMINT"
      },
      "fungibility": "non-fungible",
      "onChain": {
        "chain": "polygon",
        "type": "erc-721",
        "contractAddress": "0x9564bD85f3D5677D86244dDb06F06bbD22D9d0DB"
      },
      "supplyLimit": 95,
      "payments": {
        "price": "0.001",
        "recipientAddress": "0x6C3b3225759Cbda68F96378A9F0277B4374f9F06"
      }
    }
  ]
}

{
    "error": true,
    "message": "Empty parameter <missing parameter>"
}

{
    "error": true,
    "message": "Malformed API key. / API key provided doesn't have required scopes."
}

{
    "error": true,
    "message": "Collection <collectionId> not found"
}

{
    "error": true,
    "message": "Please try again in a few minutes. If the issue still persists, contact Crossmint support."
}
For Solana collections the onChain.contractAddress property will be named onChain.mintAddress
{
  "results": [
    {
      "id": "bb691876-edb3-404c-af3e-c019b8e2ed2c",
      "metadata": {
        "name": "Test Collection",
        "description": "Test",
        "imageUrl": "ipfs://QmVocoiYXZLAtheEHV3VF8w4pa68bkPutT8cQZdMrrpzxh",
        "symbol": "XMINT"
      },
      "fungibility": "non-fungible",
      "onChain": {
        "chain": "polygon",
        "type": "erc-721",
        "contractAddress": "0x9564bD85f3D5677D86244dDb06F06bbD22D9d0DB"
      },
      "supplyLimit": 95,
      "payments": {
        "price": "0.001",
        "recipientAddress": "0x6C3b3225759Cbda68F96378A9F0277B4374f9F06"
      }
    }
  ]
}

{
    "error": true,
    "message": "Empty parameter <missing parameter>"
}

{
    "error": true,
    "message": "Malformed API key. / API key provided doesn't have required scopes."
}

{
    "error": true,
    "message": "Collection <collectionId> not found"
}

{
    "error": true,
    "message": "Please try again in a few minutes. If the issue still persists, contact Crossmint support."
}

Authorizations

​
X-API-KEY
string
header
required

Obtained in the Crossmint developer console

Response

Success.

​
results
object[]