curl -s \
  "https://engine.example.com/v1/instruments/FUND/headroom" \
  -H "Authorization: Bearer $TOKEN"

// A client from OpenAPI Generator: see Build a client.
import {
  Configuration,
  PoliciesApi,
  ProblemFromJSON,
  ResponseError,
} from "./nodeasset-client";

const api = new PoliciesApi(new Configuration({
  basePath: "https://engine.example.com",
  accessToken: process.env.TOKEN,
}));

try {
  const answer = await api.getInstrumentHeadroom({ instrumentId: "FUND" });
  console.log(answer.value);
} catch (e) {
  if (!(e instanceof ResponseError)) throw e;
  // A refusal is a problem; its type ends in the slug.
  const problem = ProblemFromJSON(await e.response.json());
  const slug = problem.type.split(":").pop();
  console.error(e.response.status, slug, problem.detail);
}

# A client from OpenAPI Generator: see Build a client.
import os
import sys

import nodeasset_client

config = nodeasset_client.Configuration(
    host="https://engine.example.com",
    access_token=os.environ["TOKEN"],
)
with nodeasset_client.ApiClient(config) as client:
    api = nodeasset_client.PoliciesApi(client)
    try:
        answer = api.get_instrument_headroom(instrument_id="FUND")
        print(answer.value)
    except nodeasset_client.ApiException as e:
        # A refusal is a problem; its type ends in the slug.
        problem = nodeasset_client.Problem.from_json(e.body)
        slug = problem.type.rsplit(":", 1)[-1]
        print(e.status, slug, problem.detail, file=sys.stderr)

// A client from OpenAPI Generator: see Build a client.
import nodeasset.client.ApiClient;
import nodeasset.client.ApiException;
import nodeasset.client.api.PoliciesApi;
import nodeasset.client.model.Problem;

public class GetInstrumentHeadroom {
  public static void main(String[] args) throws Exception {
    ApiClient client = new ApiClient();
    client.updateBaseUri("https://engine.example.com");
    client.setRequestInterceptor(builder ->
        builder.header("Authorization", "Bearer " + System.getenv("TOKEN")));
    PoliciesApi api = new PoliciesApi(client);

    try {
      var request = PoliciesApi.APIGetInstrumentHeadroomRequest.newBuilder()
          .instrumentId("FUND")
          .build();
      var answer = api.getInstrumentHeadroom(request);
      System.out.println(answer.getValue());
    } catch (ApiException e) {
      // A refusal is a problem; its type ends in the slug.
      Problem problem = client.getObjectMapper()
          .readValue(e.getResponseBody(), Problem.class);
      String type = problem.getType();
      String slug = type.substring(type.lastIndexOf(':') + 1);
      System.err.println(e.getCode() + " " + slug + " " + problem.getDetail());
    }
  }
}

{
  "offset": 669,
  "ledgerTime": "2026-10-03T13:26:02.511209Z",
  "now": "2026-10-03T13:26:06.163504511Z",
  "value": {
    "instrumentId": "FUND",
    "policyVersion": 1,
    "day": "2026-10-03",
    "supply": {
      "cap": 100000000,
      "inIssue": 21000,
      "claimedAhead": 250,
      "left": 99978750
    },
    "holders": {
      "cap": 100,
      "counted": 3,
      "left": 97
    },
    "issuance": {
      "limit": 5000000,
      "used": 250,
      "left": 4999750
    },
    "redemption": {
      "limit": null,
      "used": 120,
      "left": null
    },
    "supplyLedger": {
      "cap": 100000000,
      "issued": 21000,
      "left": 99978750,
      "liquidateOnly": false,
      "issuance": {
        "limit": 5000000,
        "used": 0,
        "left": 5000000,
        "endsAt": "2026-10-04T13:22:18.611274Z"
      },
      "redemption": {
        "limit": null,
        "used": 120,
        "left": null,
        "endsAt": "2026-10-04T13:24:41.218043Z"
      }
    },
    "holder": {
      "holderId": "alpha",
      "balance": 5250,
      "claimedAhead": 250,
      "maxBalance": 50000000,
      "balanceLeft": 49994500,
      "lockedUp": 250,
      "issuanceLeft": null,
      "redemptionLeft": null
    }
  }
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "requestId": "<string>",
  "gate": "<string>",
  "check": "<string>",
  "recovery": "<string>",
  "retryAfter": 123,
  "retryable": true,
  "packageName": "<string>",
  "party": "<string>",
  "contractId": "<string>",
  "projectionOffset": 123,
  "ledgerEnd": 123,
  "code": 123,
  "reason": "<string>",
  "policyVersion": 123,
  "errors": [
    {
      "pointer": "<string>",
      "detail": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "requestId": "<string>",
  "gate": "<string>",
  "check": "<string>",
  "recovery": "<string>",
  "retryAfter": 123,
  "retryable": true,
  "packageName": "<string>",
  "party": "<string>",
  "contractId": "<string>",
  "projectionOffset": 123,
  "ledgerEnd": 123,
  "code": 123,
  "reason": "<string>",
  "policyVersion": 123,
  "errors": [
    {
      "pointer": "<string>",
      "detail": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "requestId": "<string>",
  "gate": "<string>",
  "check": "<string>",
  "recovery": "<string>",
  "retryAfter": 123,
  "retryable": true,
  "packageName": "<string>",
  "party": "<string>",
  "contractId": "<string>",
  "projectionOffset": 123,
  "ledgerEnd": 123,
  "code": 123,
  "reason": "<string>",
  "policyVersion": 123,
  "errors": [
    {
      "pointer": "<string>",
      "detail": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "requestId": "<string>",
  "gate": "<string>",
  "check": "<string>",
  "recovery": "<string>",
  "retryAfter": 123,
  "retryable": true,
  "packageName": "<string>",
  "party": "<string>",
  "contractId": "<string>",
  "projectionOffset": 123,
  "ledgerEnd": 123,
  "code": 123,
  "reason": "<string>",
  "policyVersion": 123,
  "errors": [
    {
      "pointer": "<string>",
      "detail": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "requestId": "<string>",
  "gate": "<string>",
  "check": "<string>",
  "recovery": "<string>",
  "retryAfter": 123,
  "retryable": true,
  "packageName": "<string>",
  "party": "<string>",
  "contractId": "<string>",
  "projectionOffset": 123,
  "ledgerEnd": 123,
  "code": 123,
  "reason": "<string>",
  "policyVersion": 123,
  "errors": [
    {
      "pointer": "<string>",
      "detail": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "requestId": "<string>",
  "gate": "<string>",
  "check": "<string>",
  "recovery": "<string>",
  "retryAfter": 123,
  "retryable": true,
  "packageName": "<string>",
  "party": "<string>",
  "contractId": "<string>",
  "projectionOffset": 123,
  "ledgerEnd": 123,
  "code": 123,
  "reason": "<string>",
  "policyVersion": 123,
  "errors": [
    {
      "pointer": "<string>",
      "detail": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "requestId": "<string>",
  "gate": "<string>",
  "check": "<string>",
  "recovery": "<string>",
  "retryAfter": 123,
  "retryable": true,
  "packageName": "<string>",
  "party": "<string>",
  "contractId": "<string>",
  "projectionOffset": 123,
  "ledgerEnd": 123,
  "code": 123,
  "reason": "<string>",
  "policyVersion": 123,
  "errors": [
    {
      "pointer": "<string>",
      "detail": "<string>"
    }
  ]
}