Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Isometric Retirements API

The Retirements API from Isometric — 4 operation(s) for retirements.

Isometric Retirements API is one of 36 APIs that Isometric publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Retirements. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and a changelog.

This API exposes 5 operations across 4 paths, and defines 19 schemas. It is described by OpenAPI 3.1.0, at version v0.

Requests are made against 2 base URLs: https://api.sandbox.isometric.com/mrv/v0, https://api.isometric.com/mrv/v0.

5 operations 4 paths 19 schemas 3 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v0
Base URL
https://api.isometric.com/registry/v0
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Isometric Retirements API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (HTTPBearer).

  • HTTPBearer — A JWT Bearer token header for authentication and authorization, in the format Authorization: Bearer

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Retirements 5
GET
/retirements
Retirements
retirements_retirements_get 7 params → 200422
POST
/retirements
Create Retirement
create_retirement_retirements_post 1 param body → 200422
POST
/retirements/from_oldest_credits
Create Retirement From Oldest Credits
create_retirement_from_oldest_credits_retirements_from_oldest_credits_post 1 param body → 200422
GET
/retirements/{id}
Retirement
retirement_retirements__id__get 2 params → 200422
GET
/retirements/{id}/credit_batches
Retirement Credit Batches
retirement_credit_batches_retirements__id__credit_batches_get 2 params → 200422

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are CreditBatch (22 properties), CreateRetirementOldestCreditsRequest (8 properties), Retirement (8 properties), CreateRetirementByBatchRequest (6 properties). Each schema is shown below with its type and property counts.

ListResource_CreditBatch_
object
2 properties 2 required
Organisation
object
3 properties 3 required
CreditQuantity
object
2 properties 2 required
PageInfo
object
4 properties 4 required
CarbonRemovalData
object
5 properties 5 required
PaginatedListResource_Retirement_
object
3 properties 3 required
Retirement
object
8 properties 8 required
RetirementPurpose
string
IsometricIDRequestParam_Retirement_
string
IsometricIDRequestParam_Organisation_
string
CreateRetirementOldestCreditsRequest
object
8 properties 6 required
IsometricIDQueryParam_Organisation_
ValidationError
object
5 properties 3 required
CreditBatchStatus
string
CreditBatchQuantity
object
2 properties 2 required
HTTPValidationError
object
1 property
CreditBatch
object
22 properties 22 required
IsometricIDPathParam_Retirement_
CreateRetirementByBatchRequest
object
6 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

isometric-retirements-api-openapi.yml Raw ↑

Other APIs Isometric publishes across the network.

Isometric MCP Server
Isometric Beneficiaries API
Isometric Beneficiary API
Isometric Biochar Applications API
Isometric Component Blueprints API
Isometric Components API
Isometric Credit Batches API
Isometric Data Upload Submissions API
Isometric Datapoints API
Isometric Deliveries API
Isometric Feedstock Batches API
Isometric Feedstock Types API