Credentials Management

Superusers create a client ID and client secret in Brokerdash (API/Devs). Exchange them for a Bearer token as described on the Authentication page. Live and sandbox credentials are not interchangeable.

GIFT City supports Client Secret only. Private Key JWT and the legacy API-key flow are not available. Expiration dates and fine-grained access control are set in Brokerdash when you create the credentials.

User Permissions

All user roles can view the credentials management page and see the list of existing credentials. Only superusers can create new API credentials.

Credentials Expiration

To help enhance the security of your account and integration, all generated credentials can be assigned a specific expiration timeframe. After that date they stop working.

The following options are available:

Never
1 week
30 days
90 days
6 months
1 year
Custom - select your own expiration date

Fine-grained access control

When generating new API credentials, you have the option to define granular permissions using Access Controls. This feature is designed to enhance the security of your integration, while also allowing you to ensure a key only has the access required to perform its designated function.

You can choose from three distinct access control levels:

Read only: Grants permission to view data across all API scopes.

Full access: Grants permission to view and modify data across all API scopes.

Custom: Grants fine-grained, specific permissions for each API scope individually.

Custom Access Controls

Instead of granting universal Read only or Full access, you can specify the access level for each distinct API scope.

For each API scope you can assign one of the following access levels:

Read & Write: Grants full permission to both view and modify data within that scope.

Read only: Grants permission to view data only.

No Access: Completely blocks all endpoints within that scope for this key.

You can choose one of the three custom access levels for the following scopes:

Accounts
Funding
Admin
Rebalancing
Trading
Journaling
Data
Reporting
SSE events