GEgetstream
product:chat

Get rate limits

Changed on

Get rate limits usage and quotas

get/rate_limits

Request

  • Base URL
    https://chat.stream-io-api.com
  • URL
    https://chat.stream-io-api.com/rate_limits
  • Auth
    • API key in header Authorization and API key in query parameter api_key and API key in header Stream-Auth-Type
    • or API key in query parameter api_key and API key in header Stream-Auth-Type

Query parameters

server_sideboolean

Whether to include server-side platform limits or not

androidboolean

Whether to include Android platform limits or not

iosboolean

Whether to include iOS platform limits or not

webboolean

Whether to include web platform limits or not

unityboolean

Whether to include Unity platform limits or not

unity_desktopboolean

Whether to include Unity desktop platform limits or not

unity_consoleboolean

Whether to include Unity console platform limits or not

endpointsstring

Specific endpoints to show limits for, as a comma-separated list of values

Response

Get Rate Limits Response

androidobject

Map of endpoint rate limits for the Android platform

durationstring required
iosobject

Map of endpoint rate limits for the iOS platform

server_sideobject

Map of endpoint rate limits for the server-side platform

unityobject

Map of endpoint rate limits for the Unity platform

unity_consoleobject

Map of endpoint rate limits for the Unity console platform

unity_desktopobject

Map of endpoint rate limits for the Unity desktop platform

webobject

Map of endpoint rate limits for the web platform

Changes

  • 30f95dce0284Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 6fe8ff33bcb3Revision changes
    • info

      added the new optional query request parameter unity_console

    • info

      added the new optional query request parameter unity_desktop

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status