Carbonmark Orders API

The Orders API from Carbonmark — 2 operation(s) for orders.

GitHub OpenAPI

Operations 3

GET /orders Order list #
POST /orders Create order #
GET /orders/{id} Order details #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/carbonmark-com:carbonmark-com-orders-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

carbonmark-com-orders-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Carbonmark REST Orders API
  license:
    name: Proprietary
  description: 'Welcome to the API Reference docs for **version v20** of the Carbonmark REST API.


    Use this API to view assets, prices, supply, activity and more.


    To find the latest stable version, visit docs.carbonmark.com.


    ## Quick start

    Be sure to prefix a version number, otherwise your application will be exposed to breaking changes.


    ~~~ts

    const res = await fetch("https://v20.api.carbonmark.com/projects");

    const projects = await res.json();

    ~~~


    For a developer guides and example implementations, or to learn more about Carbonmark and the Carbon Market, view our product knowledge base at docs.carbonmark.com.

    ##'
  termsOfService: https://www.carbonmark.com/terms-of-use
  contact:
    name: Support
    url: https://www.carbonmark.com/contact-us
  version: v20
servers:
- url: https://v20.api.carbonmark.com
tags:
- name: Orders
paths:
  /orders:
    get:
      summary: Order list
      tags:
      - Orders
      description: Get a list of retirement orders optionally filtered by id
      parameters:
      - schema:
          type: array
          items:
            type: number
        example: 74
        in: query
        name: ids
        required: false
        description: IDs of specific orders
      - schema:
          type: string
        example: a18ea1ed-5909-46f2-aba5-242852fd7f85
        in: query
        name: quote_uuid
        required: false
        description: UUID of the quote related to the order
      - schema:
          type: string
        examples:
          Bearer cm_api_d286bc5a-9980-43b7-9507-7fc013fecca8:
            value: Bearer cm_api_d286bc5a-9980-43b7-9507-7fc013fecca8
          ? Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJhdXRoZW50aWNhdGVkIiwiZXhwIjoxNzExMjcyNzMyLCJpYXQiOjE3MTEyNjkxMzIsImlzcyI6Imh0dHA6Ly8xMjcuMC4wLjE6NTQzMjEvYXV0aC92MSIsInN1YiI6IjUzZjljZjAwLTIxMWYtNGI1OS04NDY4LWUwYWMwYzg4MTZjZiIsImVtYWlsIjoidXNlcjFAZXhhbXBsZS5jb20iLCJwaG9uZSI6IiIsImFwcF9tZXRhZGF0YSI6eyJwcm92aWRlciI6ImVtYWlsIiwicHJvdmlkZXJzIjpbImVtYWlsIl19LCJ1c2VyX21ldGFkYXRhIjp7fSwicm9sZSI6ImF1dGhlbnRpY2F0ZWQiLCJhYWwiOiJhYWwxIiwiYW1yIjpbeyJtZXRob2QiOiJwYXNzd29yZCIsInRpbWVzdGFtcCI6MTcxMTAzMjM0Nn1dLCJzZXNzaW9uX2lkIjoiNmFkZjg2ZWMtNTRhZS00NmFmLWE2NTgtYzA3ODgwZmVkY2QwIn0.uRi8T-GSlYDIoYIAmHnRxYKrgK483CBDUkaItopCUko
          : value: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJhdXRoZW50aWNhdGVkIiwiZXhwIjoxNzExMjcyNzMyLCJpYXQiOjE3MTEyNjkxMzIsImlzcyI6Imh0dHA6Ly8xMjcuMC4wLjE6NTQzMjEvYXV0aC92MSIsInN1YiI6IjUzZjljZjAwLTIxMWYtNGI1OS04NDY4LWUwYWMwYzg4MTZjZiIsImVtYWlsIjoidXNlcjFAZXhhbXBsZS5jb20iLCJwaG9uZSI6IiIsImFwcF9tZXRhZGF0YSI6eyJwcm92aWRlciI6ImVtYWlsIiwicHJvdmlkZXJzIjpbImVtYWlsIl19LCJ1c2VyX21ldGFkYXRhIjp7fSwicm9sZSI6ImF1dGhlbnRpY2F0ZWQiLCJhYWwiOiJhYWwxIiwiYW1yIjpbeyJtZXRob2QiOiJwYXNzd29yZCIsInRpbWVzdGFtcCI6MTcxMTAzMjM0Nn1dLCJzZXNzaW9uX2lkIjoiNmFkZjg2ZWMtNTRhZS00NmFmLWE2NTgtYzA3ODgwZmVkY2QwIn0.uRi8T-GSlYDIoYIAmHnRxYKrgK483CBDUkaItopCUko
        in: header
        name: Authorization
        required: false
        description: Authorization header bearing either a session token or an API key prefixed with 'Bearer ' in either case.
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Order'
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: number
                  error:
                    type: string
      operationId: getOrders
      x-operation-id-source: derived
    post:
      summary: Create order
      tags:
      - Orders
      description: Consume a Quote and convert it into an Order. Creates a retirement at the quoted price and quantity.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                quote_uuid:
                  description: UUID of the quote you want to create an order from
                  type: string
                  example: e632eafd-9a67-4af1-8acc-16d72f5a738f
                beneficiary_name:
                  maxLength: 255
                  minLength: 1
                  description: 'Name of the person or organization who is claiming the environmental benefit of the retired credits. Note: this name is a permanent public record.'
                  type: string
                  example: Mother Nature
                beneficiary_address:
                  anyOf:
                  - maxLength: 42
                    minLength: 42
                    description: Wallet address to which the retirement will be attributed to.
                    examples:
                    - '0x6fb0e62afB345951997bd5149a313df9fcB72C2d'
                    pattern: ^0x(?!0{40}$)[a-fA-F0-9]{40}$
                    type: string
                  - type: 'null'
                retirement_message:
                  maxLength: 500
                  minLength: 1
                  description: 'A message to attach to the retirement, displayed on the final Carbonmark certificate. Note: this message is a permanent public record.'
                  type: string
                  example: This is a retirement message
                consumption_metadata:
                  anyOf:
                  - description: Consumption metadata for the order. This is required to retire credits from the Puro.Earth registry.
                    type: object
                    properties:
                      country_of_consumption_code:
                        description: ISO 3166 Alpha 2 country of consumption code.
                        type: string
                      consumption_period_start:
                        description: Start of the consumption period in unix seconds.
                        type: number
                      consumption_period_end:
                        description: End of the consumption period in unix seconds.
                        type: number
                    required:
                    - country_of_consumption_code
                    - consumption_period_start
                    - consumption_period_end
                  - type: 'null'
              required:
              - quote_uuid
              - beneficiary_name
              - retirement_message
        required: true
      parameters:
      - schema:
          type: string
        example: Bearer cm_api_d286bc5a-9980-43b7-9507-7fc013fecca8
        in: header
        name: Authorization
        required: true
        description: Bearer token
      - schema: {}
        in: header
        name: Idempotency-Key
        required: false
        description: Key used to replay prepaid order requests. When supplied for a prepaid order, it must be 1–200 characters and not blank. If omitted, the lowercase quote_uuid is used.
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order'
              examples:
                Consume a Quote and convert it into an Order. Creates a retirement at the quoted price and quantity.:
                  value:
                    created_at: '2024-03-25T22:01:23.236141+00:00'
                    updated_at: '2024-03-25T22:01:23.236141+00:00'
                    status: SUBMITTED
                    transaction_hash: null
                    view_retirement_url: null
                    quote:
                      asset_price_source_id: listing-137-0x12dbdff6fa065abc002324b5f2c1546b06e0440b1906438669a492e1987690f4
                      uuid: 07495f6c-8b02-465d-8fdd-4bcc2d2047e9
                      created_at: '2024-03-25T22:01:23.236141+00:00'
                      updated_at: '2024-03-25T22:01:23.236141+00:00'
                      credential_id: 93
                      quantity_tonnes: 1
                      cost_usdc: 0.5
                      consumed: 0
                    consumption_metadata: {}
                    registry_specific_data: {}
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                anyOf:
                - type: object
                  properties:
                    error:
                      type: string
                    code:
                      type: string
                    recovery:
                      type: object
                      properties:
                        action:
                          anyOf:
                          - type: string
                            enum:
                            - top_up
                          - type: string
                            enum:
                            - contact_sales
                          - type: string
                            enum:
                            - contact_support
                          - type: string
                            enum:
                            - retry
                        limit:
                          type: number
                        remaining:
                          type: number
                        used:
                          type: number
                        window_hours:
                          type: number
                        requested_amount:
                          type: number
                        available_balance:
                          type: number
                        next_available_at:
                          anyOf:
                          - type: string
                          - type: 'null'
                      required:
                      - action
                  required:
                  - error
                - type: object
                  properties:
                    message:
                      type: string
                    name:
                      type: string
                  required:
                  - message
                  - name
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '402':
          description: Default Response
          content:
            application/json:
              schema:
                anyOf:
                - type: object
                  properties:
                    error:
                      type: string
                    code:
                      type: string
                    recovery:
                      type: object
                      properties:
                        action:
                          anyOf:
                          - type: string
                            enum:
                            - top_up
                          - type: string
                            enum:
                            - contact_sales
                          - type: string
                            enum:
                            - contact_support
                          - type: string
                            enum:
                            - retry
                        limit:
                          type: number
                        remaining:
                          type: number
                        used:
                          type: number
                        window_hours:
                          type: number
                        requested_amount:
                          type: number
                        available_balance:
                          type: number
                        next_available_at:
                          anyOf:
                          - type: string
                          - type: 'null'
                      required:
                      - action
                  required:
                  - error
                - type: object
                  properties:
                    message:
                      type: string
                    name:
                      type: string
                  required:
                  - message
                  - name
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                anyOf:
                - type: object
                  properties:
                    error:
                      type: string
                    code:
                      type: string
                    recovery:
                      type: object
                      properties:
                        action:
                          anyOf:
                          - type: string
                            enum:
                            - top_up
                          - type: string
                            enum:
                            - contact_sales
                          - type: string
                            enum:
                            - contact_support
                          - type: string
                            enum:
                            - retry
                        limit:
                          type: number
                        remaining:
                          type: number
                        used:
                          type: number
                        window_hours:
                          type: number
                        requested_amount:
                          type: number
                        available_balance:
                          type: number
                        next_available_at:
                          anyOf:
                          - type: string
                          - type: 'null'
                      required:
                      - action
                  required:
                  - error
                - type: object
                  properties:
                    message:
                      type: string
                    name:
                      type: string
                  required:
                  - message
                  - name
        '409':
          description: Default Response
          content:
            application/json:
              schema:
                anyOf:
                - type: object
                  properties:
                    error:
                      type: string
                    code:
                      type: string
                    recovery:
                      type: object
                      properties:
                        action:
                          anyOf:
                          - type: string
                            enum:
                            - top_up
                          - type: string
                            enum:
                            - contact_sales
                          - type: string
                            enum:
                            - contact_support
                          - type: string
                            enum:
                            - retry
                        limit:
                          type: number
                        remaining:
                          type: number
                        used:
                          type: number
                        window_hours:
                          type: number
                        requested_amount:
                          type: number
                        available_balance:
                          type: number
                        next_available_at:
                          anyOf:
                          - type: string
                          - type: 'null'
                      required:
                      - action
                  required:
                  - error
                - type: object
                  properties:
                    message:
                      type: string
                    name:
                      type: string
                  required:
                  - message
                  - name
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: number
                  error:
                    type: string
        '503':
          description: Default Response
          content:
            application/json:
              schema:
                anyOf:
                - type: object
                  properties:
                    error:
                      type: string
                    code:
                      type: string
                    recovery:
                      type: object
                      properties:
                        action:
                          anyOf:
                          - type: string
                            enum:
                            - top_up
                          - type: string
                            enum:
                            - contact_sales
                          - type: string
                            enum:
                            - contact_support
                          - type: string
                            enum:
                            - retry
                        limit:
                          type: number
                        remaining:
                          type: number
                        used:
                          type: number
                        window_hours:
                          type: number
                        requested_amount:
                          type: number
                        available_balance:
                          type: number
                        next_available_at:
                          anyOf:
                          - type: string
                          - type: 'null'
                      required:
                      - action
                  required:
                  - error
                - type: object
                  properties:
                    message:
                      type: string
                    name:
                      type: string
                  required:
                  - message
                  - name
      operationId: postOrders
      x-operation-id-source: derived
  /orders/{id}:
    get:
      summary: Order details
      tags:
      - Orders
      description: Get a retirement order details by ID
      parameters:
      - schema:
          type: number
        example: 74
        in: path
        name: id
        required: true
        description: ID of the order
      - schema:
          type: string
        examples:
          Bearer cm_api_d286bc5a-9980-43b7-9507-7fc013fecca8:
            value: Bearer cm_api_d286bc5a-9980-43b7-9507-7fc013fecca8
          ? Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJhdXRoZW50aWNhdGVkIiwiZXhwIjoxNzExMjcyNzMyLCJpYXQiOjE3MTEyNjkxMzIsImlzcyI6Imh0dHA6Ly8xMjcuMC4wLjE6NTQzMjEvYXV0aC92MSIsInN1YiI6IjUzZjljZjAwLTIxMWYtNGI1OS04NDY4LWUwYWMwYzg4MTZjZiIsImVtYWlsIjoidXNlcjFAZXhhbXBsZS5jb20iLCJwaG9uZSI6IiIsImFwcF9tZXRhZGF0YSI6eyJwcm92aWRlciI6ImVtYWlsIiwicHJvdmlkZXJzIjpbImVtYWlsIl19LCJ1c2VyX21ldGFkYXRhIjp7fSwicm9sZSI6ImF1dGhlbnRpY2F0ZWQiLCJhYWwiOiJhYWwxIiwiYW1yIjpbeyJtZXRob2QiOiJwYXNzd29yZCIsInRpbWVzdGFtcCI6MTcxMTAzMjM0Nn1dLCJzZXNzaW9uX2lkIjoiNmFkZjg2ZWMtNTRhZS00NmFmLWE2NTgtYzA3ODgwZmVkY2QwIn0.uRi8T-GSlYDIoYIAmHnRxYKrgK483CBDUkaItopCUko
          : value: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJhdXRoZW50aWNhdGVkIiwiZXhwIjoxNzExMjcyNzMyLCJpYXQiOjE3MTEyNjkxMzIsImlzcyI6Imh0dHA6Ly8xMjcuMC4wLjE6NTQzMjEvYXV0aC92MSIsInN1YiI6IjUzZjljZjAwLTIxMWYtNGI1OS04NDY4LWUwYWMwYzg4MTZjZiIsImVtYWlsIjoidXNlcjFAZXhhbXBsZS5jb20iLCJwaG9uZSI6IiIsImFwcF9tZXRhZGF0YSI6eyJwcm92aWRlciI6ImVtYWlsIiwicHJvdmlkZXJzIjpbImVtYWlsIl19LCJ1c2VyX21ldGFkYXRhIjp7fSwicm9sZSI6ImF1dGhlbnRpY2F0ZWQiLCJhYWwiOiJhYWwxIiwiYW1yIjpbeyJtZXRob2QiOiJwYXNzd29yZCIsInRpbWVzdGFtcCI6MTcxMTAzMjM0Nn1dLCJzZXNzaW9uX2lkIjoiNmFkZjg2ZWMtNTRhZS00NmFmLWE2NTgtYzA3ODgwZmVkY2QwIn0.uRi8T-GSlYDIoYIAmHnRxYKrgK483CBDUkaItopCUko
        in: header
        name: Authorization
        required: false
        description: Authorization header bearing either a session token or an API key prefixed with 'Bearer ' in either case.
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order'
              examples:
                Completed Retire from Seller Listing Order:
                  value:
                    id: 496
                    created_at: '2024-03-25T22:01:23.236141+00:00'
                    updated_at: '2024-03-25T22:01:28.904913+00:00'
                    credential_id: 93
                    asset_id: '0x21bd8fb50a19ebe871df34f39ba29e7c8cda7834'
                    erc1155_token_id: null
                    quantity_tonnes: 1
                    cost_usdc: 0.5
                    status: COMPLETED
                    transaction_hash: '0x8ac5781ec60052d576d1447d2d895f8559022fec81322ef4f50e64eb1b2c8012'
                    gas_cost_matic: 0.022019225292686514
                    polygonscan_url: https://polygonscan.com/tx/0x8ac5781ec60052d576d1447d2d895f8559022fec81322ef4f50e64eb1b2c8012
                    view_retirement_url: https://app.carbonmark.com/retirements/0x37e69d45e5789fadfbf33b62b2a8a692edd4c96a/313
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: number
                  error:
                    type: string
      operationId: getOrdersById
      x-operation-id-source: derived
components:
  schemas:
    Quote:
      type: object
      properties:
        uuid:
          description: Reference of the quote. use this in the `POST /orders` endpoint if you want to create an order from this quote.
          type: string
        created_at:
          type: string
        updated_at:
          type: string
        credential_id:
          description: ID of the credentials used to create this quote.
          type: number
        asset_price_source_id:
          description: ID of the asset price source.
          type: string
          example: listing-137-0x886289a280cd265093215ff2893c29ff24c1381e830f63b0c71a335a7f15b362
        quantity_tonnes:
          description: Number of tonnes quoted.
          type: number
        cost_usdc:
          description: Amount in USD which will be invoiced if this quote is converted to an order.
          type: number
        consumed:
          description: Equals 1 if this quote was used to create an order, 0 otherwise. A consumed quote can no longer be used to create an order.
          type: number
      required:
      - uuid
      - created_at
      - updated_at
      - credential_id
      - asset_price_source_id
      - quantity_tonnes
      - cost_usdc
      - consumed
    Order:
      type: object
      properties:
        created_at:
          type: string
        updated_at:
          type: string
        status:
          description: Status of the order.
          anyOf:
          - title: SUBMITTED
            description: 'Status of the order: Order created.'
            type: string
            enum:
            - SUBMITTED
          - title: INITIATED
            description: 'Status of the order: Order taken into account by our bots.'
            type: string
            enum:
            - INITIATED
          - title: COMMITTED
            description: 'Status of the order: Transaction committed to the blockchain.'
            type: string
            enum:
            - COMMITTED
          - title: MINTED
            description: 'Status of the order: Transaction confirmed on the blockchain.'
            type: string
            enum:
            - MINTED
          - title: COMPLETED
            description: 'Status of the order: Transaction indexed.'
            type: string
            enum:
            - COMPLETED
          - title: FAILED
            description: Transaction failed.
            type: string
            enum:
            - FAILED
          type: string
        consumption_metadata:
          description: Puro.Earth specific data for the order.
          type: object
          properties:
            retiring_address:
              description: Address to retire the carbon credits to.
              type: string
            country_of_consumption:
              description: ISO 3166 country of consumption.
              type: string
            country_of_consumption_code:
              description: ISO 3166 Alpha 2 country of consumption code.
              type: string
            consumption_period_start:
              description: Start of the consumption period in unix seconds
              type: number
            consumption_period_end:
              description: End of the consumption period in unix seconds.
              type: number
        registry_specific_data:
          description: Registry specific data for the order.
          type: object
          properties:
            puro_earth:
              description: Puro specific data for the order.
              type: object
              properties:
                puro_batch_token_id:
                  description: Puro batch token ID.
                  type: string
        completed_at:
          anyOf:
          - description: Time the transaction was confirmed on the blockchain if the transaction completed successfully.
            type: string
          - type: 'null'
        transaction_hash:
          anyOf:
          - description: Hash of the transaction related to this order.
            type: string
          - type: 'null'
        retirement_message:
          anyOf:
          - description: Message associated with the retirement.
            type: string
          - type: 'null'
        retirement_index:
          anyOf:
          - description: Index of the retirement for the given beneficiary address
            type: number
          - type: 'null'
        beneficiary_name:
          anyOf:
          - description: Beneficiary of the retirement.
            type: string
          - type: 'null'
        beneficiary_address:
          anyOf:
          - description: Wallet address to which the retirement will be attributed to.
            type: string
          - type: 'null'
        on_chain_explorer_url:
          anyOf:
          - description: URL of the retirement transaction on the appropriate on-chain explorer
            type: string
          - type: 'null'
        view_retirement_url:
          anyOf:
          - description: URL on Carbonmark to view and download the retirement certificate.
            type: string
          - type: 'null'
        quote:
          $ref: '#/components/schemas/Quote'
      required:
      - created_at
      - updated_at
      - status
      - consumption_metadata
      - registry_specific_data
      - quote
externalDocs:
  url: https://docs.carbonmark.com/
  description: Additional documentation. The complete product and platform knowledge base for Carbonmark can be found here.