OAuth2 Documentation

OAuth2 allows..

Client credentials​

You may retrieve a set of client credentials by generating an API token (see our API V2 Documentation) and accessing the "Details" page of that token. These client credentials are tied to the token (meaning the token's enabled scopes & disabled status). You are required to set the token's "Project name" for authorization requests to proceed. This project name will be displayed on the OAuth2 authorization page along with your username and the scopes you are requesting.

You may only issue requests against API V2 endpoints when:

• The token has the relevant scope enabled (and thus, you have permission for the scope in the first place)
• We allow OAuth2 usage for that endpoint, indicated on the scopes list via either ("OAuth2 allowed" or "OAuth2 disallowed")

Endpoints & Authentication​

Authorization: https://builtbybit.com/account/external/authorize
Token: https://api.builtbybit.com/oauth2/token
Token revocation: https://api.builtbybit.com/oauth2/token/revoke

Requests to the token & token revocation endpoints must be authorized via HTTP Basic Authentication using your token's client credentials. A pre-encoded header has been included on your token's "Details" page for convenience. Requests against API V2 endpoints must be authorized via HTTP Bearer Authentication, using the access token you retrieved from the token endpoint.

OpenAPI specification & wrappers​

The token & token revocation endpoints have been included in our API V2 OpenAPI specification & wrappers. See our API V2 Documentation for more information.