Skip to content
NAR Registry
/
OpenAPI Specs
/account/
Counterparties

NAR Registry Client API (1.0.0)

This API is used for retrieving and transacting NAR Monthly vintage certificates. APIs require an OAuth Authentication token. To create API credentials, see Creating an API Login.

Download OpenAPI description
nar.client.v1.openapi.json
nar.client.v1.openapi.yaml
Overview
E-mail
nar@apx.com
Languages
Servers
Generated server url
https://narenewables2.apx.com/ClientAPI/

account

Account Information

Operations

Counterparties

Request

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).

Security
JWT
Query
counterpartyAccountIdsArray of integers(int32)

Counterparty account ids: if specified, limits the results to the counterparty accounts whose ids match the provided set

$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

$applystring

OData-like apply expression with groupby and aggregate only

curl -i -X GET \
  'https://narenewables2.apx.com/ClientAPI/api/account/counterparty?counterpartyAccountIds=0&%24filter=string&%24orderby=string&%24skip=0&%24top=0&%24apply=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
@countinteger(int32)
valueArray of objects(Counterparty)required
value[].​accountIdinteger(int32)required

The account identifier

Example: "55"
value[].​namestringrequired

The account name

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

The account type

Example: "General Account"
value[].​websitestring

The account website

Example: "acmecorp.com"
value[].​isTransferorboolean

Indicates whether the account is eligible to sell certificates.

value[].​isTransfereeboolean

Indicates whether the account is eligible to buy certificates.

totalCountinteger(int32)
countExceededbooleanrequired
Response
application/json
{
  "@count": 0,
  "value": [
    { … }
  ],
  "totalCount": 0,
  "countExceeded": true
}

ledger

Ledger Operations

Operations

subaccount

Subaccount Operations

Operations

system

System Information

Operations