INinteractivebrokers
OAuth

Obtain a live session token

In order to access protected IB resources, a live session token is required. This endpoint allows consumers to obtain a live session token to access these resources using an OAuth access token and the Diffie-Hellman prime and generator supplied during the registration process. Note this is an additional IB-specific step, and not part of the OAuth v1.0a specification. Please refer to the "OAuth at Interactive Brokers" document for more details. https://www.interactivebrokers.com/webtradingapi/oauth.pdf

post/oauth/live_session_token

Request

  • Base URL
    https://www.interactivebrokers.com/tradingapi/v1
  • URL
    https://www.interactivebrokers.com/tradingapi/v1/oauth/live_session_token
  • Auth
    API key in header portal

Request body

oauth_consumer_keystring

The 25-character hexadecimal string that was obtained from Interactive Brokers during the OAuth consumer registration process.

oauth_tokenstring

The request token obtained from IB via /request_token.

oauth_signature_methodstring

The signature method used to sign the request. Currently only 'RSA-SHA256' is supported.

oauth_signaturestring

The signature for the request generated using the method specified in the oauth_signature_method parameter. See section 9 of the OAuth v1.0a specification for more details on signing requests.

oauth_timestampstring

Timestamp expressed in seconds since 1/1/1970 00:00:00 GMT. Must be a positive integer and greater than or equal to any timestamp used in previous requests.

oauth_noncestring

A random string uniquely generated for each request.

diffie_hellman_challengestring

Challenge value calculated using the Diffie-Hellman prime and generated provided during the registration process. See the "OAuth at Interactive Brokers" document for more details.

Response

DH response

diffie_hellman_responsestring
live_session_token_signaturestring

Changes

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