Skip to content
TIGR Registry
/
OpenAPI Specs
/
/
Holdings

TIGRS Registry Client API (1.0.0)

This API is used for retrieving and retiring TIGR certificates. APIs require an OAuth Authentication token. To create API credentials, please reach out to the TIGR administrator.

Download OpenAPI description
tigr.client.v1.openapi.json
tigr.client.v1.openapi.yaml
Overview
E-mail
tigrs@apx.com
Languages
Servers
https://tigrsregistry.apx.com:443/clientapi/

corporateEntity

Corporate Entities Operations

Operations

ledger

Ledger Operations

Operations

Holdings

Request

Security
JWT
Query
accountIdsArray of strings

Account ids: if specified, limits results to the items related to the accounts whose ids match the provided set; otherwise, all results related to any authorized account will be returned

vintageStartstring(date-time)

Vintage start (inclusive). Example: 2024-08-01T00:00:00Z

vintageEndstring(date-time)

Vintage end (exclusive). Example: 2024-08-31T00:00:00Z

programstring

Program code

$filterstring

OData-like filter expression

$orderbystring

Comma-separated list of columns for sorting

$skipinteger(int32)

Number of records to skip

$topinteger(int32)

Maximum number of records to return

curl -i -X GET \
  'https://tigrsregistry.apx.com/clientapi/api/ledger/holding?accountIds=string&vintageStart=2019-08-24T14%3A15%3A22Z&vintageEnd=2019-08-24T14%3A15%3A22Z&program=string&%24filter=string&%24orderby=string&%24skip=0&%24top=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
@countinteger(int32)
countExceededbooleanrequired
totalCountinteger(int32)
valueArray of objects(Holding)required
value[].​accountIdstringrequired

The account identifier

Example: "55"
value[].​beneficialOwnerstring

The beneficial owner

Example: "Acme Corp."
value[].​certificateSerialNumberRangestringrequired

The certificate serial number range

Example: "TIGR-1234-GT-SM-08-2024-321-1 to 66"
value[].​certificateStatusstringrequired

The certificate status: see documentation for possible values

Example: "RETIRED"
value[].​countryIso2Codestringrequired

The country to which resource belongs as an ISO-2 code

Example: "GT"
value[].​creditTypestringrequired

The credit type: see documentation for possible values

Example: "TIGR"
value[].​fuelTypeCodestringrequired

The fuel type code: see documentation for possible values

Example: "HRR"
value[].​fuelTypeDescriptionstringrequired

The fuel type description: see documentation for possible values

Example: "Hydroelectric - Run-of-River"
value[].​quantitynumberrequired

The holding quantity

Example: "55"
value[].​resourceNamestringrequired

The resource name

Example: "Acme Hydro Unit 1"
value[].​resourceProgramAssignedIdentifierstringrequired

The resource identifier

Example: "1234"
value[].​retireDatestring(date-time)

The retire date

Example: "2024-01-24T03:01:57.82Z"
value[].​retirementDetailsstring

Additional retirement details

Example: "Retired for Green Energy Program"
value[].​retirementReasonCodestring

The retirement reason code: see documentation for possible values

Example: "7"
value[].​retirementReasonDescriptionstring

The retirement reason description: see documentation for possible values

Example: "Meet Corporate Renewable Energy Goals"
value[].​retirementTypeCodestringrequired

The retirement type code: see documentation for possible values

Example: "OTH"
value[].​retirementTypeDescriptionstringrequired

The retirement type description: see documentation for possible values

Example: "On Behalf of Corporate Retirement"
value[].​subaccountIdstringrequired

The subaccount identifier

Example: "99"
value[].​subaccountNamestringrequired

The subaccount name

Example: "Acme Retirements"
value[].​vintageEndstring(date-time)required

The vintage end

Example: "2024-08-31T00:00:00Z"
value[].​vintageStartstring(date-time)required

The vintage start

Example: "2024-08-01T00:00:00Z"
Response
application/json
{
  "@count": 0,
  "countExceeded": true,
  "totalCount": 0,
  "value": [
    { … }
  ]
}

Retirements

Request

Security
JWT
Query
onBehalfOfAccountIdstring

Account id for which the request is being made: defaults to the primary account id of the requester unless specified

Bodyapplication/jsonrequired

Retire requests

requestsArray of objects(RetireRequest)

List of requests

curl -i -X POST \
  'https://tigrsregistry.apx.com/clientapi/api/ledger/retire?onBehalfOfAccountId=string' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "requests": [
      {
        "certificateSerialNumberRange": "TIGR-1234-GT-SM-08-2024-321-1 to 55",
        "correlationId": "1",
        "details": "Retired for Green Energy Program",
        "emailNotification": "jdoe@acmecorp.com",
        "onBehalfOfCorporateEntityId": "99",
        "quantity": "55",
        "reasonCode": "7",
        "retirementCertificateType": "TIGR",
        "retirementTypeCode": "OTH",
        "subaccountId": "99",
        "year": "2024"
      }
    ]
  }'

Responses

OK

Bodyapplication/json
responsesArray of objects(RetireResponse)

List of responses

submissionIdstringrequired

Submission identifier for issue investigation

Response
application/json
{
  "responses": [
    { … }
  ],
  "submissionId": "string"
}

subaccount

SubAccount Operations

Operations

system

System Information

Operations