ALalpacahq
OAuth

Get an OAuth client

The endpoint returns the details of OAuth client to display in the authorization page.

get/v1/oauth/clients/{client_id}

Request

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

Query parameters

response_type'code' | 'token'
Example:token

code or token

redirect_uristring
Example:https://example.com/authorize

Redirect URI of the OAuth flow

scopestring
Example:general

Requested scopes by the OAuth flow

Response

Success.

client_idstring

OAuth client id

descriptionstring
live_trading_approvedboolean
namestring

Broker name (your name)

privacy_policystring

URL of Privacy Policy

redirect_uristring[]
status'ACTIVE' | 'DISABLED'

ACTIVE or DISABLED

terms_of_usestring

URL of Terms of Use

urlstring

Example response

{
  "client_id": "7a3c52a910e1dc2abbb14da2b6b8e711",
  "description": "Sample description",
  "live_trading_approved": true,
  "name": "TradingApp",
  "privacy_policy": "",
  "redirect_uri": [
    "http://localhost"
  ],
  "status": "ACTIVE",
  "terms_of_use": "",
  "url": "http://test.com"
}

Changes

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