Make a rate-limited request that counts toward the limit

GEThttps://api.testingapis.com/api/RateLimitSign in to see this endpoint's URL

Header (optional): X-Client-Id: <any id>; without it the remote IP is used. Responses carry X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset (Unix seconds). The 6th request in a window gets 429 with Retry-After in seconds.

Parameters 1

Name	Type	Description
`X-Client-Id`	header · string	Rate-limit bucket id (defaults to your IP). Use a unique value to get a fresh window.

Responses

200: Request allowed.
429: Limit exceeded; retry after the Retry-After delay.

Example

Request

curl -X GET "https://api.testingapis.com/api/RateLimit" \
  -H "X-Client-Id: docs-demo" \
  -H "X-TestingApis-Key: YOUR_API_KEY"

Response200 OK

X-RateLimit-Limit: 5
X-RateLimit-Remaining: 4
X-RateLimit-Reset: 1790792858

{
  "message": "Request allowed.",
  "clientId": "id:docs-demo",
  "used": 1,
  "remaining": 4,
  "limit": 5,
  "windowSeconds": 60
}

The parameters, request and response examples and the live Try it panel for this endpoint are for signed-in members. Accounts are free and take a few seconds to create.

Try itSign-in requiredUses your key

api.testingapis.com

curl 'https://api.testingapis.com/api/RateLimit' \
  -H 'X-Client-Id: docs-demo' \
  -H 'X-TestingApis-Key: YOUR_API_KEY'

const res = await fetch("https://api.testingapis.com/api/RateLimit", {
  headers: {
    "X-Client-Id": "docs-demo",
    "X-TestingApis-Key": "YOUR_API_KEY",
  },
});
console.log(res.status, await res.text());

// The shape of the example response in the docs.
type ApiResponse = {
  message: string;
  clientId: string;
  used: number;
  remaining: number;
  limit: number;
  windowSeconds: number;
};

const res = await fetch("https://api.testingapis.com/api/RateLimit", {
  headers: {
    "X-Client-Id": "docs-demo",
    "X-TestingApis-Key": "YOUR_API_KEY",
  },
});
const body = (await res.json()) as ApiResponse;
console.log(res.status, body);

import requests

res = requests.get(
    "https://api.testingapis.com/api/RateLimit",
    headers={
        "X-Client-Id": "docs-demo",
        "X-TestingApis-Key": "YOUR_API_KEY",
    },
)
print(res.status_code, res.text)

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://api.testingapis.com/api/RateLimit");
request.Headers.TryAddWithoutValidation("X-Client-Id", "docs-demo");
request.Headers.TryAddWithoutValidation("X-TestingApis-Key", "YOUR_API_KEY");
using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder(URI.create("https://api.testingapis.com/api/RateLimit"))
                .header("X-Client-Id", "docs-demo")
                .header("X-TestingApis-Key", "YOUR_API_KEY")
                .GET()
                .build();
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, err := http.NewRequest("GET", "https://api.testingapis.com/api/RateLimit", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("X-Client-Id", "docs-demo")
	req.Header.Set("X-TestingApis-Key", "YOUR_API_KEY")
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	data, err := io.ReadAll(res.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(res.StatusCode, string(data))
}

GEThttps://api.testingapis.com/api/RateLimit

Query

Headers

X-Client-Idstring