Skip to main content
GET
/
v1-alpha1
/
projects
/
{projectId}
/
usage
Get Usage
curl --request GET \
  --url https://staging.crossmint.com/api/v1-alpha1/projects/{projectId}/usage \
  --header 'X-API-KEY: <api-key>'
import requests

url = "https://staging.crossmint.com/api/v1-alpha1/projects/{projectId}/usage"

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-alpha1/projects/{projectId}/usage', 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-alpha1/projects/{projectId}/usage",
  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-alpha1/projects/{projectId}/usage"

	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-alpha1/projects/{projectId}/usage")
  .header("X-API-KEY", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://staging.crossmint.com/api/v1-alpha1/projects/{projectId}/usage")

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
{
  "data": {
    "dimension": "<string>",
    "usage": {
      "month": "<string>",
      "activeWallets": 123
    }
  }
}
{
  "error": true,
  "message": "<string>",
  "validationErrors": [
    {
      "message": "<string>",
      "index": 123,
      "id": "<string>"
    }
  ]
}
{
  "error": "<string>",
  "message": "<string>"
}
{
  "error": "<string>",
  "message": "<string>"
}
This is an alpha API and subject to change.

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
projectId
string
default:default
required

You can find your project ID in the Crossmint console.

Query Parameters

​
dimension
enum<string>
default:monthly_active_wallets
required

The dimension you want to query, for example monthly_active_wallets. The type of usage data to return.

Available options:
monthly_active_wallets
​
startDate
string
required

The startDate you want to query in YYYY-MM format, for example 2023-11 for November 2023. The startDate of usage data to return.

​
endDate
string

The endDate you want to query in YYYY-MM format, for example 2023-12 for December 2023. The endDate of usage data to return.

Response

Success.

​
data
object