# NAR Registry Client API


This API is used for retrieving and transacting NAR Monthly vintage certificates. APIs require an OAuth Authentication token. To create API credentials, see <a href="https://nar.zendesk.com/hc/en-us/articles/25002082817175-Account-Holder-API">Creating an API Login</a>.


Version: 1.0.0

## Servers

Generated server url
```
https://narenewables2.apx.com/ClientAPI
```

## Security

### JWT

Type: http
Scheme: bearer
Bearer Format: JWT

## Download OpenAPI description

[NAR Registry Client API](https://developer.xpansiv.com/_bundle/openapi/nar-registry-client-v1/nar.client.v1.openapi.yaml)

## account

Account Information

### Counterparties

 - [GET /api/account/counterparty](https://developer.xpansiv.com/openapi/nar-registry-client-v1/nar.client.v1.openapi/account/getcounterparties.md): A request to retrieve a list of accounts in the registry that are valid for certificate transfers. This should be all NAR accounts that can buy or sell certificates (this will not include MA Biomass accounts).

## ledger

Ledger Operations

### Inter-Account Transfers

 - [POST /api/ledger/transfer](https://developer.xpansiv.com/openapi/nar-registry-client-v1/nar.client.v1.openapi/ledger/interaccounttransfer.md): Initiate certificate transfers to other registry account holders. Transfers must then be confirmed by the counterparty.

### Pending Transfer Actions

 - [POST /api/ledger/transfer/pending/action](https://developer.xpansiv.com/openapi/nar-registry-client-v1/nar.client.v1.openapi/ledger/actionpendingtransfers.md): Perform actions on pending transfers of monthly certificates between accounts (either incoming or outgoing). Note that actions for incoming and outgoing transfers can be included in the same submission.

### SubAccount Transfers

 - [POST /api/ledger/subaccountTransfer](https://developer.xpansiv.com/openapi/nar-registry-client-v1/nar.client.v1.openapi/ledger/subaccounttransfer.md): Initiate transfers of monthly certificates to other sub-accounts within an account.

### Retirements

 - [POST /api/ledger/retire](https://developer.xpansiv.com/openapi/nar-registry-client-v1/nar.client.v1.openapi/ledger/retire.md): Initiate retirements of monthly certificates within an account.

### Certificate Holdings

 - [GET /api/ledger/holding](https://developer.xpansiv.com/openapi/nar-registry-client-v1/nar.client.v1.openapi/ledger/getholdings.md): Retrieve the list of all monthly certificates held by the API user (hourly certificates are not included). This will return certificates belonging to the API user that are in active and retired states.

### Pending Transfers

 - [GET /api/ledger/transfer/pending](https://developer.xpansiv.com/openapi/nar-registry-client-v1/nar.client.v1.openapi/ledger/getpendingtransfers.md): Retrieve the list of all pending monthly certificate intra-registry transfers for Monthly vintage certificates for an account/accounts. Results do not include pending imports or export.

## subaccount

Subaccount Operations

### SubAccounts

 - [GET /api/ledger/subaccount](https://developer.xpansiv.com/openapi/nar-registry-client-v1/nar.client.v1.openapi/subaccount/getsubaccounts.md): Retrieve a list  of subaccounts.

## system

System Information

### Ping System

 - [GET /api/system/ping](https://developer.xpansiv.com/openapi/nar-registry-client-v1/nar.client.v1.openapi/system/ping.md): For connectivity testing. Checks for server health and ensures a valid auth token is being properly provided.