eBay Trading API Call Reference Version 827 Support     Knowledge Base     Forums     All Tutorials     All Code Samples Users Guide Call Reference Making an API Call Tutorials Release Notes

Call Index Field Index Enumeration Index Type Index Deprecated Objects Errors by Number Input Output Detail Controls Samples Change History Top Errors for GetApiAccessRules User Notes

GetApiAccessRules

Use this call to report on how many calls your application has made and how many it is allowed to make. The call retrieves the access rules for various calls and shows how many calls your application has made in the past hour and past day.

Call rates are set by eBay and can be limited on an application basis or a per-user basis, depending on your customer base and distribution format. Call rate limits are set at the sole discretion of eBay. Applications are rate-limited on a per application basis or per user, depending on your customer base and distribution format. Note the following:

• Application-based call limits represent a maximum API call cap on a daily and monthly basis.
• User-based call limits result in each user of your application having his or her own pool of API calls. One person's usage does not affect another's.

The rules define how many times an application can use certain API calls each day or hour. A day starts at 00:00:00 PST (midnight) and ends at 11:59:59 PST. An hour is measured from the beginning of the hour, 12:00, 1:00, and so on. Your application also has an aggregate call limit, although not all calls are counted toward the limit.

GetApiAccessRules has no call-specific input fields. You only pass in the fields that are standard for all calls (e.g., RequesterCredentials). If the call is successful, it returns a number of ApiAccessRule containers, where each one has the details of the respective access rule. Each access rule contains a CallName. Parse the response for each call name, paying special attention to the values for DailyUsage, HourlyUsage, and PeriodicUsage.

For a summary of your application calls, search the response for a CallName field whose value is ApplicationAggregate, and review the values for DailyUsage, HourlyUsage, and PeriodicUsage to see how many API calls you have made.

The easiest way to track your application's API usage statistics is to use the API Usage Report, available from the My Account page on the eBay Developers Program web site. The next best way is to use GetApiAccessRules. Use this call for diagnostic purposes only, for example, when your application has blocked calls. Your application does not need to call it regularly to check daily and hourly usage.

Below are some sample access rule values for ApplicationAggregate (a call summary):

<ApiAccessRule>
	<CallName>ApplicationAggregate</CallName>
	<CountsTowardAggregate>true</CountsTowardAggregate>
	<DailyHardLimit>100000000</DailyHardLimit>
	<DailySoftLimit>90000000</DailySoftLimit>
	<DailyUsage>37897</DailyUsage>
	<HourlyHardLimit>100000000</HourlyHardLimit>
	<HourlySoftLimit>90000000</HourlySoftLimit>
	<HourlyUsage>2056</HourlyUsage>
	<Period>-1</Period>
	<PeriodicHardLimit>0</PeriodicHardLimit>
	<PeriodicSoftLimit>0</PeriodicSoftLimit>
	<PeriodicUsage>0</PeriodicUsage>
	<ModTime>2008-03-27T20:49:51.000Z</ModTime>
	<RuleCurrentStatus>NotSet</RuleCurrentStatus>
	<RuleStatus>RuleOn</RuleStatus>
</ApiAccessRule>

Use GetApiAccessRules in the Sandbox to become familiar with the various access limits for your application. Call it periodically in Production to keep an eye on the limits you may be approaching. How often you call it depends on your developer tier and on the tasks your application performs. Any blocked calls become usable during the next day or hour, depending on the type of call.

To test the call in the Sandbox, add one or more calls to GetApiAccessRules in various spots in your application to test its API usage. Remove the calls before moving into the Production environment.

See Compatible Application Check.

Back to top

GetApiAccessRules Input

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.

The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).

<?xml version="1.0" encoding="utf-8"?>
<GetApiAccessRulesRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- (No call-specific Input fields) -->

  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
</GetApiAccessRulesRequest>

Back to top

GetApiAccessRules Output

The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).

<?xml version="1.0" encoding="utf-8"?>
<GetApiAccessRulesResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <ApiAccessRule> ApiAccessRuleType
    <CallName> string </CallName>
    <CountsTowardAggregate> boolean </CountsTowardAggregate>
    <DailyHardLimit> long </DailyHardLimit>
    <DailySoftLimit> long </DailySoftLimit>
    <DailyUsage> long </DailyUsage>
    <HourlyHardLimit> long </HourlyHardLimit>
    <HourlySoftLimit> long </HourlySoftLimit>
    <HourlyUsage> long </HourlyUsage>
    <ModTime> dateTime </ModTime>
    <Period> int </Period>
    <PeriodicHardLimit> long </PeriodicHardLimit>
    <PeriodicSoftLimit> long </PeriodicSoftLimit>
    <PeriodicStartDate> dateTime </PeriodicStartDate>
    <PeriodicUsage> long </PeriodicUsage>
    <RuleCurrentStatus> AccessRuleCurrentStatusCodeType </RuleCurrentStatus>
    <RuleStatus> AccessRuleStatusCodeType </RuleStatus>
  </ApiAccessRule>
  <!-- ... more ApiAccessRule nodes allowed here ... -->
  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <Build> string </Build>
  <CorrelationID> string </CorrelationID>
  <Errors> ErrorType
    <ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
    <ErrorCode> token </ErrorCode>
    <ErrorParameters ParamID="string"> ErrorParameterType
      <Value> string </Value>
    </ErrorParameters>
    <!-- ... more ErrorParameters nodes allowed here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes allowed here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
</GetApiAccessRulesResponse>

Back to top

GetApiAccessRules Detail Controls

Detail Control: DetailLevel

This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.

Back to top

GetApiAccessRules Samples

New to making API calls? Please see Routing the Request.

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Retrieves the current set of API access rules and call usage for the authenticated user.

Description

Input

XML format (HTTP POST). Also available is the .txt version of this XML.

<?xml version="1.0" encoding="utf-8"?>
<GetApiAccessRulesRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>ABC...123</eBayAuthToken>
  </RequesterCredentials>
</GetApiAccessRulesRequest>

Output

XML format. Also available is the .txt version of this XML.

<GetApiAccessRulesResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2010-01-29T19:39:26.683Z</Timestamp>
  <Ack>Success</Ack>
  <Version>653</Version>
  <Build>E653_CORE_BUNDLED_10549562_R1</Build>
  <ApiAccessRule>
    <CallName>GetNotificationPreferences</CallName>
    <CountsTowardAggregate>true</CountsTowardAggregate>
    <DailyHardLimit>0</DailyHardLimit>
    <DailySoftLimit>0</DailySoftLimit>
    <DailyUsage>0</DailyUsage>
    <HourlyHardLimit>0</HourlyHardLimit>
    <HourlySoftLimit>0</HourlySoftLimit>
    <HourlyUsage>0</HourlyUsage>
    <Period>-1</Period>
    <PeriodicHardLimit>0</PeriodicHardLimit>
    <PeriodicSoftLimit>0</PeriodicSoftLimit>
    <PeriodicUsage>0</PeriodicUsage>
    <ModTime>2007-11-29T22:01:30.000Z</ModTime>
    <RuleCurrentStatus>NotSet</RuleCurrentStatus>
    <RuleStatus>RuleOff</RuleStatus>
  </ApiAccessRule>
  <ApiAccessRule>
    <CallName>SetNotificationPreferences</CallName>
    <CountsTowardAggregate>true</CountsTowardAggregate>
    <DailyHardLimit>0</DailyHardLimit>
    <DailySoftLimit>0</DailySoftLimit>
    <DailyUsage>0</DailyUsage>
    <HourlyHardLimit>0</HourlyHardLimit>
    <HourlySoftLimit>0</HourlySoftLimit>
    <HourlyUsage>0</HourlyUsage>
    <Period>-1</Period>
    <PeriodicHardLimit>0</PeriodicHardLimit>
    <PeriodicSoftLimit>0</PeriodicSoftLimit>
    <PeriodicUsage>0</PeriodicUsage>
    <ModTime>2007-11-29T22:01:30.000Z</ModTime>
    <RuleCurrentStatus>NotSet</RuleCurrentStatus>
    <RuleStatus>RuleOff</RuleStatus>
  </ApiAccessRule>
  <ApiAccessRule>
    <CallName>PasswordAuthenticationLimiter</CallName>
    <CountsTowardAggregate>true</CountsTowardAggregate>
    <DailyHardLimit>0</DailyHardLimit>
    <DailySoftLimit>0</DailySoftLimit>
    <DailyUsage>0</DailyUsage>
    <HourlyHardLimit>0</HourlyHardLimit>
    <HourlySoftLimit>0</HourlySoftLimit>
    <HourlyUsage>0</HourlyUsage>
    <Period>-1</Period>
    <PeriodicHardLimit>0</PeriodicHardLimit>
    <PeriodicSoftLimit>0</PeriodicSoftLimit>
    <PeriodicUsage>0</PeriodicUsage>
    <ModTime>2007-11-29T22:01:30.000Z</ModTime>
    <RuleCurrentStatus>NotSet</RuleCurrentStatus>
    <RuleStatus>ApplicationBlocked</RuleStatus>
  </ApiAccessRule>
  <ApiAccessRule>
    <CallName>NonUTF8UsageLimiter</CallName>
    <CountsTowardAggregate>true</CountsTowardAggregate>
    <DailyHardLimit>0</DailyHardLimit>
    <DailySoftLimit>0</DailySoftLimit>
    <DailyUsage>0</DailyUsage>
    <HourlyHardLimit>0</HourlyHardLimit>
    <HourlySoftLimit>0</HourlySoftLimit>
    <HourlyUsage>0</HourlyUsage>
    <Period>-1</Period>
    <PeriodicHardLimit>0</PeriodicHardLimit>
    <PeriodicSoftLimit>0</PeriodicSoftLimit>
    <PeriodicUsage>0</PeriodicUsage>
    <ModTime>2007-11-29T22:01:30.000Z</ModTime>
    <RuleCurrentStatus>NotSet</RuleCurrentStatus>
    <RuleStatus>ApplicationBlocked</RuleStatus>
  </ApiAccessRule>
  <ApiAccessRule>
    <CallName>LegacyXmlEnforcementSoft</CallName>
    <CountsTowardAggregate>true</CountsTowardAggregate>
    <DailyHardLimit>0</DailyHardLimit>
    <DailySoftLimit>0</DailySoftLimit>
    <DailyUsage>0</DailyUsage>
    <HourlyHardLimit>0</HourlyHardLimit>
    <HourlySoftLimit>0</HourlySoftLimit>
    <HourlyUsage>0</HourlyUsage>
    <Period>0</Period>
    <PeriodicHardLimit>0</PeriodicHardLimit>
    <PeriodicSoftLimit>0</PeriodicSoftLimit>
    <PeriodicUsage>0</PeriodicUsage>
    <PeriodicStartDate>2005-04-01T00:00:00.000Z</PeriodicStartDate>
    <ModTime>2007-11-29T22:01:30.000Z</ModTime>
    <RuleCurrentStatus>NotSet</RuleCurrentStatus>
    <RuleStatus>ApplicationBlocked</RuleStatus>
  </ApiAccessRule>
  <ApiAccessRule>
    <CallName>LegacyXmlEnforcementHard</CallName>
    <CountsTowardAggregate>true</CountsTowardAggregate>
    <DailyHardLimit>0</DailyHardLimit>
    <DailySoftLimit>0</DailySoftLimit>
    <DailyUsage>0</DailyUsage>
    <HourlyHardLimit>0</HourlyHardLimit>
    <HourlySoftLimit>0</HourlySoftLimit>
    <HourlyUsage>0</HourlyUsage>
    <Period>0</Period>
    <PeriodicHardLimit>0</PeriodicHardLimit>
    <PeriodicSoftLimit>0</PeriodicSoftLimit>
    <PeriodicUsage>0</PeriodicUsage>
    <PeriodicStartDate>2005-04-01T00:00:00.000Z</PeriodicStartDate>
    <ModTime>2007-11-29T22:01:30.000Z</ModTime>
    <RuleCurrentStatus>NotSet</RuleCurrentStatus>
    <RuleStatus>ApplicationBlocked</RuleStatus>
  </ApiAccessRule>
</GetApiAccessRulesResponse>

Back to top

GetApiAccessRules Change History

Back to top

User-Contributed Notes

Copyright © 2005–2013 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.