Skip to main content
API docs by Redocly

Puro.earth Registry API (1.0.0)

Download OpenAPI specification:Download

Puro.earth Oy: tech-support@puro.earth URL: https://puro.earth

Authorization

The Puro.earth's registry API uses role-based access control (RBAC) to assign and manage rights for users. If a request is made by a user who lacks the needed authorization, the request will instead return either an HTTP 403 Forbidden or HTTP 404 Not Found response.

Not Found responses are reserved for cases where the application cannot determine whether the resource exists or whether the user is not able to interact with it. In endpoints that list multiple resources, only those the user is authorized to view will be returned.

Production facilities

List production facilities

Authorizations:
API
query Parameters
limit
integer [ 1 .. 100 ]

How many items to return at one time (max 100)

offset
integer >= 0

How many items to skip

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Get production facility by code

Authorizations:
API
path Parameters
productionFacilityCode
required
string

The code of the production facility to retrieve

Responses

Response samples

Content type
application/json
{
  • "code": "P51023",
  • "gsrn": "643002406801000400",
  • "name": "Production facility 1",
  • "methodologyCode": "C010000000",
  • "generalRules": {},
  • "supplierName": "string",
  • "supplierListingUrl": "http://example.com",
  • "sdgs": [
    ],
  • "country": "US",
  • "certificationStatus": "NOT_AVAILABLE",
  • "creditingPeriod": {
    }
}

Transactions

Get transactions by id

Authorizations:
API
path Parameters
transactionId
required
string <uuid>

The id of the transaction to retrieve

Responses

Response samples

Content type
application/json
{
  • "transactionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  • "volume": 100,
  • "completedOn": "2019-08-24T14:15:22Z",
  • "accountHolderName": "Biochar Inc",
  • "type": "Issuance",
  • "bundles": [
    ],
  • "labels": [
    ],
  • "issuanceDetails": {
    },
  • "retirementDetails": {
    }
}

List transactions

Authorizations:
API
query Parameters
transactionType
string
Enum: "Issuance" "Transfer" "InternalTransfer" "Retirement" "Withdrawal"

Select the transaction type to retrieve transaction

productionFacilityCode
string

The code of the production facility to retrieve Transaction

limit
integer [ 1 .. 100 ]

How many items to return at one time (max 100)

offset
integer >= 0

How many items to skip

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Certificates

List certificates

Authorizations:
API
query Parameters
limit
integer [ 1 .. 100 ]

How many items to return at one time (max 100)

offset
integer >= 0

How many items to skip

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Methodologies

List methodologies

Authorizations:
API
query Parameters
limit
integer [ 1 .. 100 ]

How many items to return at one time (max 100)

offset
integer >= 0

How many items to skip

Responses

Response samples

Content type
application/json
{}

Documents

List documents

Authorizations:
API
query Parameters
limit
integer [ 1 .. 100 ]

How many items to return at one time (max 100)

offset
integer >= 0

How many items to skip

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Labels

List labels

Authorizations:
API
query Parameters
limit
integer [ 1 .. 100 ]

How many items to return at one time (max 100)

offset
integer >= 0

How many items to skip

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}