Check Token Support

Get a token by its locator

GET /v1-alpha2/tokens/{tokenLocator}

Check Supported Tokens

cURL

curl --request GET \
  --url https://staging.crossmint.com/api/v1-alpha2/tokens/{tokenLocator} \
  --header 'X-API-KEY: <api-key>'

import requests

url = "https://staging.crossmint.com/api/v1-alpha2/tokens/{tokenLocator}"

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/v1-alpha2/tokens/{tokenLocator}', 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-alpha2/tokens/{tokenLocator}",
  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/v1-alpha2/tokens/{tokenLocator}"

	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/v1-alpha2/tokens/{tokenLocator}")
  .header("X-API-KEY", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://staging.crossmint.com/api/v1-alpha2/tokens/{tokenLocator}")

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

200

{
  "token": "solana:6p6xgHyF7AeE6TZkSmFsko444wqoP15icUSqi2jfGiPN",
  "available": true,
  "features": {
    "creditCardPayment": true
  }
}

{
  "error": true,
  "message": "<string>",
  "parameters": {
    "amount": "<string>",
    "limit": "<string>",
    "hoursUntilReset": "<string>",
    "remainingAmount": "<string>"
  }
}

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

{
  "error": true,
  "message": "Not found"
}

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

{
  "error": true,
  "message": "A timeout occurred."
}

Authorizations

apiKeyclientApiKey

X-API-KEY · string · header · required

Path Parameters

tokenLocator · string · required

A unique identifier used to locate a specific fungible token on a blockchain. Memecoin checkout supports the Solana and Base networks. Format: <network>:<tokenAddress> (e.g. base:0xa4a2e2ca3fbfe21aed83471d28b6f65a233c6e00).

Pattern: ^solana:[1-9A-HJ-NP-Za-km-z]{32,44}$

Response

200

application/json

The token has been successfully retrieved.

Information regarding the token that was requested and its availability

token · string · required

The token locator that was queried

Example:

"solana:6p6xgHyF7AeE6TZkSmFsko444wqoP15icUSqi2jfGiPN"

available · boolean · required

Whether the token is supported by Crossmint

Example:

true

features · Token features · object · required

The features show if the token is supported for credit card payment.

Show child attributes