Rate limit headers (X-RateLimit) in Rest API

Introduction

Rate limit headers tell you how many requests you can make to a server before it stops answering. They help keep the server safe from too many requests at once.

When you want to know how many API calls you have left before being blocked.

When building an app that talks to a server and you want to avoid sending too many requests.

When you want to show users how many requests they can still make.

When you want to handle errors caused by sending too many requests gracefully.

Syntax

Rest API

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 750
X-RateLimit-Reset: 1609459200

X-RateLimit-Limit shows the total number of allowed requests in a time window.

X-RateLimit-Remaining shows how many requests you can still make before hitting the limit.

X-RateLimit-Reset shows the time when the limit will reset, usually as a Unix timestamp.

Examples

This means you can make 5000 requests total, have 4999 left, and the limit resets at the given timestamp.

Rest API

X-RateLimit-Limit: 5000
X-RateLimit-Remaining: 4999
X-RateLimit-Reset: 1672531200

You have used all 100 requests and must wait until the reset time to send more.

Rest API

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 0
X-RateLimit-Reset: 1672534800

Sample Program

This program calls an API, reads the rate limit headers, and prints how many requests you can make and when the limit resets.

Rest API

import requests
import time

url = 'https://api.example.com/data'
response = requests.get(url)

limit = response.headers.get('X-RateLimit-Limit')
remaining = response.headers.get('X-RateLimit-Remaining')
reset = response.headers.get('X-RateLimit-Reset')

print(f"Limit: {limit}")
print(f"Remaining: {remaining}")
if reset:
    reset_time = time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(int(reset)))
    print(f"Reset at: {reset_time}")

Important Notes

Not all APIs use the same rate limit headers, but X-RateLimit is common.

The reset time is usually in Unix timestamp format, which counts seconds since 1970-01-01.

Always check the headers before making many requests to avoid being blocked.

Summary

Rate limit headers tell you how many API calls you can make.

X-RateLimit-Limit is the total allowed calls.

X-RateLimit-Remaining is how many calls you have left.

X-RateLimit-Reset tells when the limit resets.

Practice

1.

What does the X-RateLimit-Remaining header indicate in a REST API response?

easy

A. The time when the rate limit will reset.

B. The total number of API calls allowed per day.

C. The number of API calls made so far.

D. The number of API calls you can still make before hitting the limit.

Solution

1. Step 1: Understand the meaning of X-RateLimit-Remaining

   This header shows how many calls you have left before reaching the limit.

2. Step 2: Compare with other headers

   X-RateLimit-Limit is total allowed calls, X-RateLimit-Reset is reset time, so remaining calls is the count left.

3. Final Answer:

   The number of API calls you can still make before hitting the limit. -> Option D

4. Quick Check:

   Remaining calls = calls left [OK]

Hint: Remaining means how many calls you can still make [OK]

Common Mistakes:

• Confusing remaining with total limit
• Thinking it shows reset time
• Assuming it counts calls made

2.

Which of the following is the correct way to read the X-RateLimit-Reset header?

HTTP/1.1 200 OK
X-RateLimit-Reset: 1686000000

easy

A. It is a Unix timestamp indicating when the limit resets.

B. It shows the number of calls left before reset.

C. It is the total allowed calls per hour.

D. It shows the current time in ISO format.

Solution

1. Step 1: Identify the header type

   X-RateLimit-Reset usually gives a timestamp for when the limit resets.

2. Step 2: Interpret the value

   The value 1686000000 looks like a Unix timestamp (seconds since 1970).

3. Final Answer:

   It is a Unix timestamp indicating when the limit resets. -> Option A

4. Quick Check:

   Reset header = Unix timestamp [OK]

Hint: Reset header is always a timestamp in seconds [OK]

Common Mistakes:

• Thinking reset shows calls left
• Confusing reset with total limit
• Assuming reset is current time

3.

Given the following response headers:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 250
X-RateLimit-Reset: 1686003600

How many API calls have been made so far?

medium

A. 750

B. 250

C. 1000

D. 1250

Solution

1. Step 1: Understand the headers

   Total allowed calls are 1000, remaining calls are 250.

2. Step 2: Calculate calls made

   Calls made = Total limit - Remaining = 1000 - 250 = 750.

3. Final Answer:

   750 -> Option A

4. Quick Check:

   1000 - 250 = 750 calls made [OK]

Hint: Calls made = Limit minus Remaining [OK]

Common Mistakes:

• Using remaining as calls made
• Adding limit and remaining
• Confusing reset time as calls made

4.

You receive these headers from an API:

X-RateLimit-Limit: 500
X-RateLimit-Remaining: -10
X-RateLimit-Reset: 1686007200

What is the likely problem?

medium

A. The headers are missing the total calls made.

B. The limit is too low for the API.

C. The remaining calls cannot be negative; it's an error.

D. The reset time is in the past.

Solution

1. Step 1: Check the X-RateLimit-Remaining value

   Remaining calls cannot be negative; it should be zero or positive.

2. Step 2: Identify the error

   A negative remaining value indicates a bug or miscalculation in the API response.

3. Final Answer:

   The remaining calls cannot be negative; it's an error. -> Option C

4. Quick Check:

   Remaining calls must be ≥ 0 [OK]

Hint: Remaining calls can never be negative [OK]

Common Mistakes:

• Ignoring negative values as valid
• Confusing reset time with remaining
• Thinking limit is the problem

5.

You want to build a client that stops making API calls when the limit is reached and waits until reset. Given these headers:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 0
X-RateLimit-Reset: 1686009000

What should your client do?

hard

A. Continue making calls; the limit resets immediately.

B. Stop calls and wait until the reset timestamp before retrying.

C. Ignore the headers and retry after 1 minute.

D. Reset the remaining count manually and continue.

Solution

1. Step 1: Check remaining calls

   Remaining is 0, so no calls can be made now.

2. Step 2: Use reset time to wait

   The client should wait until the reset timestamp before making new calls.

3. Final Answer:

   Stop calls and wait until the reset timestamp before retrying. -> Option B

4. Quick Check:

   Remaining=0 means wait until reset [OK]

Hint: Stop calls at zero remaining; wait for reset time [OK]

Common Mistakes:

• Ignoring zero remaining and continuing calls
• Guessing reset time instead of using header
• Manually resetting counters in client