API Map and Rate Limits

The following is a table of the the most common API calls and their respective rate limits.

HTTP Verb
URL
Functionality
Rate Limits (per min/per user)

POST

/oauth/<user:id>

This API call allows you to get oauth_key for users.

30

POST

/oauth/<user:id>/login

Using basic auth to get refresh_token for users.

30

GET

/users

View all users created with your client keys (paginated).

100

POST

/users

Allows you to register a new user.

100

GET

/users/<user:id>

View user info and refresh_token.

30

PATCH

/users/<user:id>

Add/update KYC, log in credentials, profile, etc.

30

GET

/users/<user:id>/nodes

View all nodes linked to a user (paginated).

100

POST

/users/<user:id>/nodes

Allows you to create a deposit account or link an external bank account to a user.

100

GET

/users/<user:id>/nodes/<node:id>

View node info.

100

PATCH

/users/<user:id>/nodes/<node:id>

Update supp_id, verify micro-deposits, etc.

100

DELETE

/users/<user:id>/nodes/<node:id>

Unindex node from a user.

100

POST

/users/<user:id>/nodes/<node:id>/subnets

Allows you to issue a virtual account number on top of a node.

100

GET

/users/<user:id>/nodes/<node:id>/subnets

View all subnets linked to a node (paginated).

100

GET

/users/<user:id>/nodes/<node:id>/subnets/<subnet:id>

View subnet info.

100

PATCH

/users/<user:id>/nodes/<node:id>/subnets/<subnet:id>

Update subnet info.

100

GET

/trans

View all transactions of a platform

100

GET

/users/<user:id>/trans

View all transactions of a user (paginated).

100

GET

/users/<user:id>/nodes/<node:id>/trans

View all transactions of a node (paginated).

100

POST

/users/<user:id>/nodes/<node:id>/trans

Allows you to create a transaction.

100

GET

/users/<user:id>/nodes/<node:id>/trans/<trans:id>

View transaction info.

100

PATCH

/users/<user:id>/nodes/<node:id>/trans/<trans:id>

Update notes on a transaction.

100

DELETE

/users/<user:id>/nodes/<node:id>/trans/<trans:id>

Only works if transaction has been created or queued.

100

GET

/subscriptions

View all subscriptions created with your client keys (paginated).

10

POST

/subscriptions

Create a subscription with webhook preferences.

10

GET

/subscriptions/<subscription:id>

View a subscription.

10

PATCH

/subscriptions/<subscription:id>

Update scope, url, is_active, etc.

10

GET

<:user_id>/statements

View a users statement

30

GET

<:node_id>/statements

View a node statements

30

API Map and Rate Limits


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.