Get Usage

Retrieve API usage statistics for the current billing period

GET /v1/organization/usage

Get Usage

cURL

curl --request GET \
  --url https://api.signa.so/v1/organization/usage \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.signa.so/v1/organization/usage"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.signa.so/v1/organization/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://api.signa.so/v1/organization/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 => [
    "Authorization: Bearer <token>"
  ],
]);

$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://api.signa.so/v1/organization/usage"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.signa.so/v1/organization/usage")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.signa.so/v1/organization/usage")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "object": "usage",
  "billing_period": {
    "start": "2026-06-01T00:00:00.000Z",
    "end": "2026-07-01T00:00:00.000Z"
  },
  "by_endpoint_type": {
    "search": { "used": 1204, "limit": 100000 },
    "read": { "used": 8932, "limit": 500000 },
    "screening": { "used": 112, "limit": 1000 },
    "check": { "used": 46, "limit": 500000 }
  },
  "rate_limits": {
    "search": 1000,
    "read": 10000,
    "screening": 100,
    "monitoring": 100,
    "utility": 1000,
    "reference": 1000,
    "check": 1000
  },
  "request_id": "req_aS6kL2mN"
}

Overview

Returns API usage for the current billing period, broken down by metered endpoint type, plus the per-endpoint-type requests-per-minute limits your plan enforces.

by_endpoint_type reports used and limit for each metered endpoint type: search, read, screening, and check. A limit of null means unlimited on your plan; 0 means the endpoint type is not available on your plan.

Requires the billing:read scope.

Response

object · string

Always usage.

billing_period · object

Show Billing period

start · string

ISO timestamp for the billing period start (inclusive).

end · string

ISO timestamp for the billing period end (exclusive).

by_endpoint_type · object

Show Per-endpoint-type usage

Keyed by metered endpoint type (search, read, screening, check). Each value is an object:

rate_limits · object

Requests-per-minute limit per endpoint type (search, read, screening, monitoring, utility, reference, check), as enforced by the rate limiter. See Rate Limits for how limits are applied.

request_id · string

Unique request identifier for support and debugging.

{
  "object": "usage",
  "billing_period": {
    "start": "2026-06-01T00:00:00.000Z",
    "end": "2026-07-01T00:00:00.000Z"
  },
  "by_endpoint_type": {
    "search": { "used": 1204, "limit": 100000 },
    "read": { "used": 8932, "limit": 500000 },
    "screening": { "used": 112, "limit": 1000 },
    "check": { "used": 46, "limit": 500000 }
  },
  "rate_limits": {
    "search": 1000,
    "read": 10000,
    "screening": 100,
    "monitoring": 100,
    "utility": 1000,
    "reference": 1000,
    "check": 1000
  },
  "request_id": "req_aS6kL2mN"
}

Code Examples

cURL

curl "https://api.signa.so/v1/organization/usage" \
  -H "Authorization: Bearer sig_YOUR_KEY"

import { Signa } from "@signa-so/sdk";

const signa = new Signa({ api_key: process.env.SIGNA_API_KEY });

const usage = await signa.organization.usage();
console.log("Search used:", usage.by_endpoint_type.search.used);

Errors

Status	Type	Description
401	unauthorized	Missing or invalid API key
403	forbidden	API key lacks the billing:read scope
429	rate_limited	Too many requests

Related Endpoints

• Get Current Organization, organization profile and plan
• Get Usage Summary, daily breakdown by endpoint type or API key
• List API Keys, manage API keys