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.
openapi: 3.2.0
info:
title: Carbonmark REST Records 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: Records
paths:
/retirements/{id}/provenance:
get:
summary: Retirement provenance records
tags:
- Records
description: Retrieve a retirement provenance records
parameters:
- schema:
type: string
example: 84532-0x1ee2facc42147cc6f6cd1fcdca4e3748d2b41b089fafac46515318bbce4f633c-0
in: path
name: id
required: true
description: Id of the retirement
responses:
'200':
description: Retirement provenance record for a given retirement index and beneficiary address
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ProvenanceRecord'
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
properties:
statusCode:
type: number
error:
type: string
operationId: getRetirementsByIdProvenance
x-operation-id-source: derived
components:
schemas:
ProvenanceRecord:
type: object
properties:
id:
description: ID of the provenance record
type: string
transactionType:
description: Type of the the provenance record (ORIGINATION, TRANSFER or RETIREMENT)
type: string
transactionHash:
description: Hash of the transaction pertaining to the record
type: string
registrySerialNumbers:
type: array
items:
description: For ORIGINATION of bridged credits only. Serial number of the bridging event.
type: string
token:
description: Address of the token
type: string
sender:
description: Address of the sender
type: string
receiver:
description: Address of the receiver
type: string
originalAmount:
description: Amount owned by the sender before the event
type: number
remainingAmount:
description: Amount owned by the sender after the event
type: number
createdAt:
type: number
updatedAt:
type: number
required:
- id
- transactionType
- transactionHash
- registrySerialNumbers
- token
- sender
- receiver
- originalAmount
- remainingAmount
- createdAt
- updatedAt
externalDocs:
url: https://docs.carbonmark.com/
description: Additional documentation. The complete product and platform knowledge base for Carbonmark can be found here.