Transactions

Get all transactions

get

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

limitnumberOptional

Limit the number of results returned

pagenumberOptional

Page number for pagination

Responses

200Success

application/json

get

/v1/transactions

HTTPcURLJavaScriptPython

GET /v1/transactions HTTP/1.1
Host: api.carbonregistry.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "transactions": [
    {
      "action": "transfer",
      "type": "exAnte",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "toAddress": "0x1234567890abcdef",
      "createdAt": "2022-01-01T00:00:00Z",
      "updatedAt": "2022-01-01T00:00:00Z",
      "tokenId": "123e4567-e89b-12d3-a456-426614174000",
      "tokenAddress": "0x1234567890abcdef",
      "creditId": "exPost-2-0x1234567890abcdef",
      "serialization": "serialization",
      "vintage": "2020",
      "amount": 1000,
      "fromOrganizationId": "123e4567-e89b-12d3-a456-426614174000",
      "toOrganizationId": "123e4567-e89b-12d3-a456-426614174000",
      "project": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "fullName": "Project 1",
        "url": "https://api.carbonregistry.com/projects/47abd663-fb35-4b2e-ad08-c347e761649e",
        "publicUrl": "https://carbonregistry.com/explore/projects/47abd663-fb35-4b2e-ad08-c347e761649e",
        "num": "713"
      },
      "txId": "0x1234567890abcdef",
      "state": "processed",
      "transactionData": {
        "creditId": "text",
        "tokenId": "text",
        "amount": 1,
        "serialization": "text"
      },
      "retirementId": "1",
      "retirementReason": "reason",
      "retirementComment": "comment",
      "beneficiaryName": "John Doe"
    }
  ]
}

Get a specific transaction by transaction ID

get

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The id of the transaction

Responses

200Success

application/json

get

/v1/transactions/{id}

HTTPcURLJavaScriptPython

GET /v1/transactions/{id} HTTP/1.1
Host: api.carbonregistry.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "transaction": {
    "action": "transfer",
    "type": "exAnte",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "toAddress": "0x1234567890abcdef",
    "createdAt": "2022-01-01T00:00:00Z",
    "updatedAt": "2022-01-01T00:00:00Z",
    "tokenId": "123e4567-e89b-12d3-a456-426614174000",
    "tokenAddress": "0x1234567890abcdef",
    "creditId": "exPost-2-0x1234567890abcdef",
    "serialization": "serialization",
    "vintage": "2020",
    "amount": 1000,
    "fromOrganizationId": "123e4567-e89b-12d3-a456-426614174000",
    "toOrganizationId": "123e4567-e89b-12d3-a456-426614174000",
    "project": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "fullName": "Project 1",
      "url": "https://api.carbonregistry.com/projects/47abd663-fb35-4b2e-ad08-c347e761649e",
      "publicUrl": "https://carbonregistry.com/explore/projects/47abd663-fb35-4b2e-ad08-c347e761649e",
      "num": "713"
    },
    "txId": "0x1234567890abcdef",
    "state": "processed",
    "transactionData": {
      "creditId": "text",
      "tokenId": "text",
      "amount": 1,
      "serialization": "text"
    },
    "retirementId": "1",
    "retirementReason": "reason",
    "retirementComment": "comment",
    "beneficiaryName": "John Doe"
  }
}

Get transactions for an entity

get

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Entity ID

Responses

200Success

application/json

get

/v1/{id}/transactions

HTTPcURLJavaScriptPython

GET /v1/{id}/transactions HTTP/1.1
Host: api.carbonregistry.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "transactions": [
    {
      "action": "transfer",
      "type": "exAnte",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "toAddress": "0x1234567890abcdef",
      "createdAt": "2022-01-01T00:00:00Z",
      "updatedAt": "2022-01-01T00:00:00Z",
      "tokenId": "123e4567-e89b-12d3-a456-426614174000",
      "tokenAddress": "0x1234567890abcdef",
      "creditId": "exPost-2-0x1234567890abcdef",
      "serialization": "serialization",
      "vintage": "2020",
      "amount": 1000,
      "fromOrganizationId": "123e4567-e89b-12d3-a456-426614174000",
      "toOrganizationId": "123e4567-e89b-12d3-a456-426614174000",
      "project": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "fullName": "Project 1",
        "url": "https://api.carbonregistry.com/projects/47abd663-fb35-4b2e-ad08-c347e761649e",
        "publicUrl": "https://carbonregistry.com/explore/projects/47abd663-fb35-4b2e-ad08-c347e761649e",
        "num": "713"
      },
      "txId": "0x1234567890abcdef",
      "state": "processed",
      "transactionData": {
        "creditId": "text",
        "tokenId": "text",
        "amount": 1,
        "serialization": "text"
      },
      "retirementId": "1",
      "retirementReason": "reason",
      "retirementComment": "comment",
      "beneficiaryName": "John Doe"
    }
  ]
}