Interface ErrorResponseRateLimited

Shared fields between all error response variants.

Hierarchy

Properties

Properties

message: string

A brief explanation of the error.

null: {
    retry_after: number;
}

Type declaration

  • retry_after: number

    The amount of milliseconds you're still rate limited for.

status: number

The HTTP status of the error.

type: "RATE_LIMITED"

The error when a client is rate limited.


Example

{
"type": "RATE_LIMITED",
"status": 429,
"message": "You have been rate limited",
"retry_after": 1234
}