How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NAR Registry Client API

The North American Renewables Registry client API for retrieving and transacting NAR monthly vintage renewable energy certificates — account, ledger, subaccount and system operations behind an OAuth2 password-grant JWT.

This API exposes 9 operations across 9 paths, organized into 4 resource areas, and defines 28 schemas. It is described by OpenAPI 3.0.1, at version 1.0.0.

Requests are made against a single base URL, https://narenewables2.apx.com/ClientAPI.

9 operations 9 paths 28 schemas 5 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0.0
Base URL
https://narenewables2.apx.com/ClientAPI
Authentication
HTTP Bearer
Resource Areas
4

Authentication & Security 1

NAR Registry Client API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (JWT). By default, every request must be authenticated.

Paths & Operations 9

Across 9 paths, the API surfaces 9 operations — 5 GET, 4 POST. They span 4 resource areas: ledger, system, account, subaccount. Each is listed below with its method, path, parameters, and response codes.

ledger 6

Ledger Operations

POST
/api/ledger/transfer
Inter-Account Transfers
interaccountTransfer 1 param body → 200400401403413429500
POST
/api/ledger/transfer/pending/action
Pending Transfer Actions
actionPendingTransfers 1 param body → 200400401403413429500
POST
/api/ledger/subaccountTransfer
SubAccount Transfers
subaccountTransfer 1 param body → 200400401403413429500
POST
/api/ledger/retire
Retirements
retire 1 param body → 200400401403413429500
GET
/api/ledger/holding
Certificate Holdings
getHoldings 9 params → 200400401403429500
GET
/api/ledger/transfer/pending
Pending Transfers
getPendingTransfers 7 params → 200400401403429500
system 1

System Information

GET
/api/system/ping
Ping System
ping → 200400401403429500
account 1

Account Information

GET
/api/account/counterparty
Counterparties
getCounterparties 6 params → 200400401403429500
subaccount 1

Subaccount Operations

GET
/api/ledger/subaccount
SubAccounts
getSubaccounts 7 params → 200400401403429500

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are Holding (24 properties), RetireResponse (15 properties), PendingTransfer (15 properties), RetireRequest (13 properties). Each schema is shown below with its type and property counts.

Counterparty
object
Counterparty information
6 properties 3 required
ErrorContainer
object
Container for errors
2 properties
ErrorItem
object
Describes a specific error
6 properties 1 required
Holding
object
Holding information
24 properties 11 required
InteraccountTransferRequest
object
Request to transfer credits to another account
4 properties 3 required
InteraccountTransferRequestDto
object
Transfer requests
1 property
InteraccountTransferResponse
object
Response to a transfer request to another account
6 properties 4 required
LedgerSubaccount
object
Subaccount information
5 properties 5 required
ODataEnvelopeWithTotalCountOfCounterparty
object
Container for OData-like rows of information with count
4 properties 2 required
ODataEnvelopeWithTotalCountOfHolding
object
Container for OData-like rows of information with count
4 properties 2 required
ODataEnvelopeWithTotalCountOfLedgerSubaccount
object
Container for OData-like rows of information with count
4 properties 2 required
ODataEnvelopeWithTotalCountOfPendingTransfer
object
Container for OData-like rows of information with count
4 properties 2 required
PendingTransfer
object
Pending transfer information
15 properties 12 required
PendingTransferActionRequest
object
Request to take action on a pending transfer
4 properties 2 required
PendingTransferActionRequestDto
object
Transfer action requests
1 property
PendingTransferActionResponse
object
Response to a pending transfer action request
4 properties 2 required
Pong
object
Response indicating server is online and auth token is valid
1 property 1 required
ResponseContainerInteraccountTransferResponse
object
Container for responses
2 properties 1 required
ResponseContainerPendingTransferActionResponse
object
Container for responses
2 properties 1 required
ResponseContainerRetireResponse
object
Container for responses
2 properties 1 required
ResponseContainerSubaccountTransferResponse
object
Container for responses
2 properties 1 required
RetireRequest
object
Request to retire credits
13 properties 4 required
RetireRequestDto
object
Retire requests
1 property
RetireResponse
object
Response to an retire request
15 properties 5 required
SubaccountTransferRequest
object
Request to transfer credits between active subaccounts
4 properties 2 required
SubaccountTransferRequestDTO
object
Subaccount transfer requests
1 property
SubaccountTransferResponse
object
Response to a transfer request between active subaccounts
6 properties 3 required
ValidationError
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xpansiv-nar-registry-client-openapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of NAR Registry Client API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.