Get rate limit status

GET 
/v1/rate_limit

Get rate limit status.

Responses

200

success response

application/json

Schema

Schema

limit integer

The maximum number of requests that you can make per period

remaining integer

The number of requests remaining in the current rate limit window

used integer

The number of requests you have made in the current rate limit window

reset integer

The time at which the current rate limit window resets, in UTC epoch seconds

Example (from schema)

{
  "limit": 0,
  "remaining": 0,
  "used": 0,
  "reset": 0
}

Example

{
  "limit": 100,
  "remaining": 99,
  "used": 1,
  "reset": 1723886474
}

400

request error

application/json

Schema

Schema

error

object

type

object

Type of error encountered.

oneOf

request_error

Typically means there's a problem with the request that you made.

api_error

Typically means there's a problem with the Temp Mail API.

code string

Error code. Some common codes are not_found, invalid_api_key, rate_limited, validation_error.

detail string

meta

object

Information about this response.

request_id string

Unique ID for the request relating to this response. Provide this when contacting Temp Mail support about a specific request.

Example (from schema)

{
  "error": {
    "type": "request_error",
    "code": "not_found",
    "detail": "Message not found"
  },
  "meta": {
    "request_id": "a48b927e-3a24-42ff-a748-d516e5474f85"
  }
}

Loading...