ALalpacahq
OAuth

Authorize an OAuth Token

The operation issues an OAuth code which can be used in the OAuth code flow.

post/v1/oauth/authorize

Request

  • Base URL
    https://broker-api.giftcity.sandbox.in.alpaca.markets
  • URL
    https://broker-api.giftcity.sandbox.in.alpaca.markets/v1/oauth/authorize
  • Auth
    HTTP basic

Request body

account_idstring uuid required

end-user account ID

client_idstring required

OAuth client ID

client_secretstring required

OAuth client secret

redirect_uristring required

redirect URI for the OAuth flow

scopestring required

scopes requested by the OAuth flow

Example request

{
  "account_id": "0d18ae51-3c94-4511-b209-101e1666416b",
  "client_id": "7a3c52a910e1dc2abbb14da2b6b8e711",
  "client_secret": "bbb14da2b6b8e7117a3c52a910e1dc2a",
  "redirect_uri": "http://localhost",
  "scope": "general"
}

Response

Successfully issued a code.

client_idstring required

OAuth client_id

codestring required

OAuth code to exchange with token

redirect_uristring required

Redirect URI of OAuth flow

scopestring required

Granted scopes

Example response

{
  "client_id": "7a3c52a910e1dc2abbb14da2b6b8e711",
  "code": "912b5502-c983-40f7-a01d-6a66f13a754d",
  "redirect_uri": "http://localhost",
  "scope": ""
}

Changes

No recorded changes to this operation across all 1 revision of this API.