Meters Overview

To prevent our servers from experiencing too much overhead, some API services are metered. Once these services are used a certain amount of times within a predefined interval, the system will respond with a message stating so.

If a meter interval has passed, the service's meter will be reset and the associated application may use the service until it runs out again.

This service allows a developer to determine how many tries they have left with each metered service they've used.

Responses

XML

<?xml version="1.0"?>
<rsp stat="fail">
        <header>
            <method>get.providers.xml</method>
            <key>API_KEY</key>
        </header>
    <error code="802" message="Allotted Service Request Limit Reached"/>
</rsp>

PHP

a:1:{s:7:"results";a:2:{s:6:"header";a:3:{s:6:"status";s:4:"fail";s:6:"method";s:17:"get.providers.php";s:3:"key";s:7:"API_KEY";}s:5:"error";a:2:{s:4:"code";i:802;s:7:"message";s:38:"Allotted Service Request Limit Reached";}}}

JSON

{"results":{"header":{"status":"fail","method":"get.providers.json","key":"API_KEY"},"error":{"code":802,"message":"Allotted Service Request Limit Reached"}}}

Services

Recent Discussions

No discussions yet!