RateLimit

The rate limit [RateLimit] is the number of API requests remaining in the current 24-hour window.

Review Usage Guidelines for the RateLimit object.

Note:

OpenAir enforces some limits to control API consumption and manage the demands on OpenAir application and database servers. One such usage limit applies to the number of requests in any 24-hour window. See API Limits.

—	XML	SOAP	REST
Object	RateLimit	oaRateLimit	—
Supported Commands	Read (all)	—	—

Note:

The RateLimit object supports the all read method only.

The RateLimit object has the following properties:

Field Name	Description
remain_24h_error	Number of calls remaining in a 24 hour window

Usage Guidelines

You can only query the remaining number of requests using the XML API. The OpenAir WSDL lists the oaRateLimit but the SOAP API does not support reading this object. The REST API does not have an equivalent method to query the remaining number of requests.

The following XML API sample code queries the remaining number of requests within the current 24-hour window:

            <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<request API_version="1.0" client="example client" client_ver="1.1" namespace="example" key="0123456789">
   <Auth>
      <Login>
         <access_token>0123456789-ABCDEFGHIJKLMNIOQRSTUVWXYZ0123456789ABCDEF-ABCDEFGHIJKLMNIOQRSTUVWXYZ01234567</access_token>
      </Login>
   </Auth>
   <Read type="RateLimit" method="all" limit="1">
   </Read>
</request> 

          

The following XML API sample response indicates that there are 99949 requests remaining within the current 24-hour window.

            <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response>
   <Auth status = "0"></Auth >
   <Read status = "0">
      <RateLimit>
         <remain_24h_error>99949</remain_24h_error>
      </RateLimit>
   </Read>
</response> 

          

Note:

This request call counts uses up one request in your API frequency limit.