Rate limiting

Trackmania Forever public API and its open source PHP SDK.

Moderator: NADEO

Post Reply
User avatar
gouxim
Nadeo
Nadeo
Posts: 1153
Joined: 14 Jun 2010, 17:20

Rate limiting

Post by gouxim » 13 May 2011, 11:28

Hey,

In order to have a scalable API, we are soon going to implement rate limiting on the API. It means that you will be allowed to make only a certain amount of requests per hour (the value is yet to be defined, but it shoud be around 200-300 requests per hour). In case you reach the limit, you will receive à 400 Bad Request error, and you'll have to wait the begining of the next hour to make requests again.

In the future we will handle special demands so that a popular application (eg. sites like tm-ladder.com) can have a higer rate limit.

Rate limiting is a fairly standard features on public web services APIs. You can check the twitter page for tips about how to avoid beeing rate limited: http://dev.twitter.com/pages/rate-limiting#tips
Please do not PM for support. Instead, create a thread so that everyone can contribute or benefit from the answer! 8-)

User avatar
fastforza
Posts: 859
Joined: 15 Jun 2010, 11:19
Contact:

Re: Rate limiting

Post by fastforza » 14 May 2011, 08:51

Interesting, nice move. 8-) You seem to like specifications set by social networks. :P
Mania Exchange - Share your maps!

ASUS Maximus IV GENE Z / i7 2600K 3.40Ghz QC / 16GB G.Skill Ripjaws DDR3 / GTX 560 Ti

Need technical help for ManiaPlanet? Click here. :)

User avatar
gouxim
Nadeo
Nadeo
Posts: 1153
Joined: 14 Jun 2010, 17:20

Re: Rate limiting

Post by gouxim » 14 May 2011, 12:47

It's not so much that I like them, it's more than those are good practices when it comes to web services. And they've been set by social network, but also by companies like google or amazon (with aws). :geek:
Please do not PM for support. Instead, create a thread so that everyone can contribute or benefit from the answer! 8-)

User avatar
destroflyer
Posts: 124
Joined: 16 Jun 2010, 22:17
Contact:

Re: Rate limiting

Post by destroflyer » 14 May 2011, 17:56

Hm... maybe it would be better to cache some of the requests instead of "forbidding" or deny them after a several amount?

User avatar
Knutselmaaster
Posts: 1267
Joined: 15 Jun 2010, 18:03
Location: Somewhere between Paris and Disney in France.
Contact:

Re: Rate limiting

Post by Knutselmaaster » 14 May 2011, 21:34

Like with the "old" datafetcher, you can always cache locally i suppose.

User avatar
gouxim
Nadeo
Nadeo
Posts: 1153
Joined: 14 Jun 2010, 17:20

Re: Rate limiting

Post by gouxim » 15 May 2011, 13:40

destroflyer wrote:Hm... maybe it would be better to cache some of the requests instead of "forbidding" or deny them after a several amount?
Caching is already done on the server, and as Knutselmaaster pointed out it's a good pratice to cache locally in your application.

Rate limiting however allows us to have a more scalable infrastucture because we can more easilly do server dimensioning.
Please do not PM for support. Instead, create a thread so that everyone can contribute or benefit from the answer! 8-)

User avatar
w1lla
Posts: 2359
Joined: 15 Jun 2010, 11:09
Location: Netherlands
Contact:

Re: Rate limiting

Post by w1lla » 16 May 2011, 22:59

The formula in the old tmf datafetcher was this±

Code: Select all

$cachetime = 86400;
		$midnight = floor(time()/86400)*86400-3600;
		$secondssincemidnight = time()-$midnight;
		$nextupdate = floor($secondssincemidnight / $cachetime)*$cachetime + $midnight;
So its useful to use this for the new providers.

Also in a old version fo tmndatafetcher there was no cache holder so its better to use the code that i justed posted.
TM² Info
SM Info
QM Info

OS: Windows 10 x64 Professional
MB: MSI 970A-G46
Processor: AMD FX-6300 3500 mHz
RAM Memory: 16 GB DDR3
Video: SAPPHIRE DUAL-X R9 280X 3GB GDDR5
KB: Logitech G510s
Mouse: Logitech G300s
Mode Creation
ManiaScript Docs

User avatar
gouxim
Nadeo
Nadeo
Posts: 1153
Joined: 14 Jun 2010, 17:20

Re: Rate limiting

Post by gouxim » 06 Jul 2011, 10:57

Rate limiting is now effective on the API. Whenever you make a request on the API, there's a X-Rate-Limit header with an x-www-form-urlencoded string (just like an URI query string, you can decoded it with the http://www.php.net/manual/en/function.parse-str.php php function).

Here's how it looks like:

Code: Select all

X-Rate-Limit: current=6&limit=2000&expires_in=3122
When the rate limit is reached, you get a "400 Bad Request" error, and the Retry-After header is included in the response:

Code: Select all

Retry-After: 2888
In the next update of the SDK I'll provide methods to easilly access those values.
Please do not PM for support. Instead, create a thread so that everyone can contribute or benefit from the answer! 8-)

Post Reply

Return to “Trackmania Forever Web Services”

Who is online

Users browsing this forum: No registered users and 1 guest