Skip to content
NAR Registry
/
OpenAPI Specs
/subaccount/
SubAccounts

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

ledger

Ledger Operations

Operations

subaccount

Subaccount Operations

Operations

SubAccounts

Request

Retrieve a list of subaccounts.

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

subaccountTypestring

Subaccount type code

Enum"ACT""RET"
$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/ledger/subaccount?accountIds=string&subaccountType=ACT&%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(LedgerSubaccount)required
value[].​accountIdinteger(int32)required

The account identifier

Example: 55
value[].​subaccountIdstringrequired

The subaccount identifier

Example: "321"
value[].​subaccountTypestringrequired

The subaccount type

Enum"ACT""RET""KSG"
Example: "ACT"
value[].​subaccountNamestringrequired

The subaccount name

Example: "Active Hydro Certificates"
value[].​openbooleanrequired

Whether the subaccount is open

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

system

System Information

Operations