Overview
Allows the user to authorize the consumer application.
Description

Once your application has the request token, it should redirect the user to an E*TRADE authorization page, as shown in the URL below. Include the request token and your consumer key as parameters in the URL as shown. The page at this URL asks the user to authorize your application. Upon approval of the authorization request, E*TRADE generates a verification code.

By default, E*TRADE then displays this verification code in an "Authorization Complete" page, allowing the user to manually copy the code and paste it into your application. However, the recommended alternative is for E*TRADE to pass the verification code directly into your application via a pre-configured callback URL.

Using a callback requires that the callback URL be associated with your consumer key in the E*TRADE system. To request this, follow the instructions in our Authorization guide chapter (separate from this API reference). Your callback URL can be just a simple address, or can also include query parameters. Once the callback is configured, users who approve the authorization request are automatically redirected to the specified URL, with the verification code appended as a query parameter. Examples are shown in the Sample Response below.

URL
https://us.etrade.com/e/t/etws/authorize?key={oauth_consumer_key}&token={oauth_token}
HTTP Method: GET
Request Parameters
Property Type Required? Description
oauth_consumer_key string Required The value used by the consumer to identify itself to the service provider.
oauth_token string Required The consumer’s request token.
Response Properties
Property Type Description
oauth_verifier query parameter verification code
Sample Request
https://us.etrade.com/e/t/etws/authorize?key=282683cc9e4b8fc81dea6bc687d46758&token=%2FiQRgQCRGPo7Xdk6G8QDSEzX0Jsy6sKNcULcDavAGgU%3D
Sample Response

As described above, the authorize call is not a REST API in the usual sense, and does not return a "response" in the usual way. If the user authorizes your application on the E*TRADE authorization site, the result is either the display of a verification code at that site or, if a callback is used, a redirect to your callback URL.

In the callback scenario, the verification code is appended to your callback URL as an oauth_verifier parameter. Here are two examples:

https://myapplicationsite.com/mytradingapp?oauth_verifier=WXYZ89
https://myapplicationsite.com?myapp=trading&oauth_verifier=WXYZ89
Notes
  • If using the default approach - letting the user copy and paste the verification code - we recommend opening a separate browser window for the authorization, leaving your application open in the original window. Once the user has authorized your application and copied the verification code, the user can simply close the authorization window and return to your application in the original window.
  • If using the callback approach, we recommend redirecting to the authorization page in the current window. Once the user has authorized your application, E*TRADE redirects the user to your callback page; the verification code is included as a URL parameter (as in the sample response above).
PLEASE READ THE IMPORTANT DISCLOSURES BELOW

By using E*TRADE API ("API") and accepting the terms of the Application Programming Interface License Agreement and the Application Programming Interface User Agreement, you agree that API may employ security policies, procedures and systems of Third Party providers which may or may not be less stringent and secure than the policies, procedures and systems of E*TRADE Securities LLC ("E*TRADE") or its affiliates. Material provided on API may have been produced by independent third parties not affiliated or endorsed by E*TRADE or its affiliates ("Third Party"). To the extent that API or Third Party providers express opinions or make recommendations, you understand that such opinions or recommendations are expressed by the Third Party provider and are not the opinions or recommendations of E*TRADE or its affiliates. E*TRADE is not responsible for the accuracy of market data displayed on API or made available by Third Party providers. There may be latency between the time an order (or other information) is submitted from API and the time the order is received by E*TRADE. The E*TRADE Two Second Execution Guarantee or any similar guarantee does not apply for orders placed through API and Third Party provider web sites. The E*TRADE CompleteTM Protection Guarantee does not apply. Orders created and submitted through API are not vetted until they are received by E*TRADE. It is possible that E*TRADE may reject an order placed through API. Please see the Application Programming Interface License Agreement and the Application Programming Interface User Agreement for more information.


The E*TRADE family of companies provides financial services including trading, investing, and related banking products and services to retail investors.


Securities products and services offered by E*TRADE Securities LLC, Member FINRA/SIPC.


System response and account access times may vary due to a variety of factors, including trading volumes, market conditions, system performance, and other factors.