Returns information on rate limits for the current consumer key.

Description

This API returns the rate limits that are applied to the specified consumer key, broken out by the Accounts, Market, and Order API modules.

The response specifies just the consumption rate, expressed as a number of requests and a time interval. For instance, a typical response might state that 7000 requests are allowed over an interval of 3600 seconds (one hour). It also tells how many requests are still available for the current interval, and the time at which the next interval will begin. Once the available requests for an interval are used up, no more requests are accepted for processing until the next interval begins at the time shown.

Error handling

When a request exceeds the limit, the system returns an HTML error page containing the message: "Number of requests exceeded the rate limit set", with the HTTP status code 400. At that point, depending on program design, a typical error-handler might call the limit API to determine whether the per-second or per-hour threshold has been exceeded.

If the response indicates that there are requests remaining for the defined interval, then the error was caused by too many requests per second. In that case, an application can re-issue the request after waiting the required fraction of a second.

However, if there are no requests allowed for the rest of the defined interval, the application will need to wait until a new interval begins (at the time indicated in the response). In this rare situation, if a pending action involves a trade or is otherwise time-sensitive, we suggest advising the user of the anticipated delay and requesting confirmation before proceeding.

URL

https://etws.etrade.com/statuses/rest/limits

HTTP Method: GET
Request Parameters
Property Type Description
oauth_consumer_key string The value used by the consumer to identify itself to the service provider.
oauth_token string The request token issued by the service provider.
module string The API module for which information is requested. Possible values are: ACCOUNTS, MARKET, ORDER.
Response Parameters
Property Type Description
oauth_consumer_key string The string used by the consumer to identify itself to the service provider
limitIntervalInSeconds integer The interval for which the limit applies, in seconds
requestLimit integer The number of requests allowed in the specified interval
requestsRemaining integer The remaining number of requests that the system will accept from the user in the current time interval
resetTime string The time when the next interval will begin
resetTimeEpochSeconds integer The time when the next interval will begin, in epoch time
Sample Request
https://etws.etrade.com/statuses/rest/limits?oauth_consumer_key=45e5jf05d7fa1021e2c81d3c7a1d2e06Z7VANJzqlp00SZR8HXqhEL1rgDORhsYet5UR1C1tlK&module=accounts&oauth_token=HYNojwqv1HVl/wmaEU6UBautoy7m5v3qj5bxZuQeT7s=
Sample Response - XML
<RateLimitStatus>
  <consumerKey>d85df5b910e3cb47b2a4cf26c20229ae</consumerKey>
  <limitIntervalInSeconds>3600</limitIntervalInSeconds>
  <requestsLimit>6500</requestsLimit>
  <requestsRemaining>6500</requestsRemaining>
  <resetTime>02-25-2010 22:16:58 GMT</resetTime>
  <resetTimeEpochSeconds>1267136218</resetTimeEpochSeconds>
</RateLimitStatus>
Sample Response - JSON
{
  "RateLimitStatus": {
    "consumerKey": "d85df5b910e3cb47b2a4cf26c20229ae",
    "limitIntervalInSeconds": "3600",
    "requestsLimit": "6500",
    "requestsRemaining": "6500",
    "resetTime": "02-25-2010 22:16:58 GMT",
    "resetTimeEpochSeconds": "1267136218"
  }
}
Notes
  • The consumer key and token should be URL-encoded since they might contain invalid characters for a URL, such as a slash or ampersand.
  • For more information on rate limits, refer to our developer's guide on Rate Limits.
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.