Rate Limits

const response = await client....
const rateLimit = response.metadata.rateLimit;
// the total limit allowed for the resource requested
console.log(rateLimit.rateLimit);
// the remaining limit
console.log(rateLimit.rateLimitRemaining);
// when the current limit will reset - Date
console.log(rateLimit.rateLimitReset);
// or
try {
  await client....
} catch (error) {
  const rateLimit = error.metadata?.rateLimit;
  if (error.metadata?.responseCode === 429) {
    // Wait until rate limit resets and then retry
  }
}

const response = await client....
const rateLimit = response.metadata.rateLimit;
// the total limit allowed for the resource requested
console.log(rateLimit.rateLimit);
// the remaining limit
console.log(rateLimit.rateLimitRemaining);
// when the current limit will reset - Date
console.log(rateLimit.rateLimitReset);
// or
try {
  await client....
} catch (error) {
  const rateLimit = error.metadata?.rateLimit;
  if (error.metadata?.responseCode === 429) {
    // Wait until rate limit resets and then retry
  }
}

const response = await client....
const rateLimit = response.metadata.rateLimit;
// the total limit allowed for the resource requested
console.log(rateLimit.rateLimit);
// the remaining limit
console.log(rateLimit.rateLimitRemaining);
// when the current limit will reset - Date
console.log(rateLimit.rateLimitReset);
// or
try {
  await client....
} catch (error) {
  const rateLimit = error.metadata?.rateLimit;
  if (error.metadata?.responseCode === 429) {
    // Wait until rate limit resets and then retry
  }
}

const response = await client....
const rateLimit = response.metadata.rateLimit;
// the total limit allowed for the resource requested
console.log(rateLimit.rateLimit);
// the remaining limit
console.log(rateLimit.rateLimitRemaining);
// when the current limit will reset - Date
console.log(rateLimit.rateLimitReset);
// or
try {
  await client....
} catch (error) {
  const rateLimit = error.metadata?.rateLimit;
  if (error.metadata?.responseCode === 429) {
    // Wait until rate limit resets and then retry
  }
}

response, err := client.QueryUsers(ctx, request)
if err != nil {
    if streamErr, ok := err.(getstream.StreamError); ok {
        if streamErr.StatusCode == 429 {
            rateLimit := streamErr.RateLimit
            // Wait until time.Unix(rateLimit.Reset, 0) and retry
        }
    }
    log.Fatal(err)
    return
}
// Payload
users := response.Data.Users
// Rate limit (same shape on every success response)
rateLimit := response.RateLimitInfo
// rateLimit.Limit   - total limit
// rateLimit.Remaining - remaining in window
// rateLimit.Reset    - Unix timestamp (seconds); convert to time: time.Unix(rateLimit.Reset, 0)

response = client.some_method(...)
# Payload
data = response.data
# Rate limit (method, not property)
rate_limit = response.rate_limit()
if rate_limit:
    print(rate_limit.limit)      # total limit
    print(rate_limit.remaining)  # remaining in window
    print(rate_limit.reset)     # datetime (UTC) when the window resets


try:
    response = client.some_method(...)
except StreamAPIException as e:
    if e.status_code == 429:
        rate_limit = e.rate_limit_info
        if rate_limit:
            # Wait until rate_limit.reset and retry
            pass

begin
  response = client.feeds.some_method(...)
  # Payload is accessible via method_missing on the response
  data = response.to_h
rescue GetStreamRuby::APIError => e
  # Check if rate limited from error message
  # Implement exponential back-off retry
end

$response = $feedsClient->someMethod(...);
// Payload
$data = $response->getData();
// Rate limit info from response headers
$limit = $response->getHeader('x-ratelimit-limit');         // total limit
$remaining = $response->getHeader('x-ratelimit-remaining'); // remaining in window
$reset = $response->getHeader('x-ratelimit-reset');         // Unix timestamp when the window resets

try {
    $response = $feedsClient->someMethod(...);
} catch (\GetStream\Exceptions\StreamApiException $e) {
    if ($e->getStatusCode() === 429) {
        // Wait until rate limit resets and retry
    }
}

try
{
    var response = await feedsClient.SomeMethodAsync(...);
    // Payload
    var data = response.Data;
}
catch (GetStreamApiException e) when (e.StatusCode == 429)
{
    // Rate limited - wait and retry with exponential back-off
}

var response = client.feeds().someMethod(...).request();
// Payload
var data = response.getData();
// Rate limit info (available on every response)
RateLimit rateLimit = response.getRateLimit();
// rateLimit.getLimit()     - total limit
// rateLimit.getRemaining() - remaining in window
// rateLimit.getReset()     - Date when the window resets

try {
    var response = client.feeds().someMethod(...).request();
} catch (StreamException e) {
    if (e.getResponseData() != null && e.getResponseData().getStatusCode() == 429) {
        // Wait until rate limit resets and retry
    }
}

// 1. Get feeds rate limits, server-side platform
const limits = await client.feeds.getFeedsRateLimits({ server_side: true });

// 2. Get feeds rate limits, all platforms
const limits = await client.feeds.getFeedsRateLimits();

// 3. Get feeds rate limits, iOS and Android
const limits = await client.feeds.getFeedsRateLimits({
  ios: true,
  android: true,
});

// 4. Get feeds rate limits for specific endpoints
const limits = await client.feeds.getFeedsRateLimits({
  endpoints: "QueryActivities,AddActivity,GetOrCreateFeed",
});

// Get rate limits (all platforms, common and moderation endpoints)
const rateLimits = await client.getRateLimits();

// 1. Get feeds rate limits, server-side platform
limits, _ := client.Feeds().GetFeedsRateLimits(ctx, getstream.WithServerSide())

// 2. Get feeds rate limits, all platforms
limits, _ := client.Feeds().GetFeedsRateLimits(ctx)

// 3. Get feeds rate limits, iOS and Android
limits, _ := client.Feeds().GetFeedsRateLimits(ctx, getstream.WithIOS(), getstream.WithAndroid())

// 4. Get feeds rate limits for specific endpoints
limits, _ := client.Feeds().GetFeedsRateLimits(ctx, getstream.WithEndpoints("QueryActivities", "AddActivity", "GetOrCreateFeed"))

// Get rate limits (all platforms, common and moderation endpoints)
limits, _ = client.GetRateLimits(ctx)

// 1. Get feeds rate limits, server-side platform
var limits = client.feeds().getFeedsRateLimits().serverSide(true).request();

// 2. Get feeds rate limits, all platforms
var limits = client.feeds().getFeedsRateLimits().request();

// 3. Get feeds rate limits, iOS and Android
var limits = client.feeds().getFeedsRateLimits().ios(true).android(true).request();

// 4. Get feeds rate limits for specific endpoints
var limits = client.feeds().getFeedsRateLimits().endpoints("QueryActivities", "AddActivity", "GetOrCreateFeed").request();

// Get rate limits (all platforms, common and moderation endpoints)
var rateLimits = client.getRateLimits().request();

// 1. Get feeds rate limits, server-side platform
$limits = $client->feeds()->getFeedsRateLimits(['server_side' => true]);

// 2. Get feeds rate limits, all platforms
$limits = $client->feeds()->getFeedsRateLimits();

// 3. Get feeds rate limits, iOS and Android
$limits = $client->feeds()->getFeedsRateLimits(['ios' => true, 'android' => true]);

// 4. Get feeds rate limits for specific endpoints
$limits = $client->feeds()->getFeedsRateLimits(['endpoints' => ['QueryActivities', 'AddActivity', 'GetOrCreateFeed']]);

// Get rate limits (all platforms, common and moderation endpoints)
$limits = $client->getRateLimits();

// 1. Get feeds rate limits, server-side platform
var limits = await client.Feeds.GetFeedsRateLimitsAsync(new GetFeedsRateLimitsOptions { ServerSide = true });

// 2. Get feeds rate limits, all platforms
var limits = await client.Feeds.GetFeedsRateLimitsAsync();

// 3. Get feeds rate limits, iOS and Android
var limits = await client.Feeds.GetFeedsRateLimitsAsync(new GetFeedsRateLimitsOptions { Ios = true, Android = true });

// 4. Get feeds rate limits for specific endpoints
var limits = await client.Feeds.GetFeedsRateLimitsAsync(new GetFeedsRateLimitsOptions
{
    Endpoints = new[] { "QueryActivities", "AddActivity", "GetOrCreateFeed" }
});

// Get rate limits (all platforms, common and moderation endpoints)
var rateLimits = await client.GetRateLimitsAsync();

# 1. Get feeds rate limits, server-side platform
limits = client.feeds.get_feeds_rate_limits(server_side=True)

# 2. Get feeds rate limits, all platforms
limits = client.feeds.get_feeds_rate_limits()

# 3. Get feeds rate limits, iOS and Android
limits = client.feeds.get_feeds_rate_limits(ios=True, android=True)

# 4. Get feeds rate limits for specific endpoints
limits = client.feeds.get_feeds_rate_limits(endpoints=["QueryActivities", "AddActivity", "GetOrCreateFeed"])

# Get rate limits (all platforms, common and moderation endpoints)
limits = client.get_rate_limits()

# 1. Get feeds rate limits, server-side platform
limits = client.feeds.get_feeds_rate_limits(server_side: true)

# 2. Get feeds rate limits, all platforms
limits = client.feeds.get_feeds_rate_limits()

# 3. Get feeds rate limits, iOS and Android
limits = client.feeds.get_feeds_rate_limits(ios: true, android: true)

# 4. Get feeds rate limits for specific endpoints
limits = client.feeds.get_feeds_rate_limits(endpoints: ['QueryActivities', 'AddActivity', 'GetOrCreateFeed'])

# Get rate limits (all platforms, common and moderation endpoints)
limits = client.get_rate_limits()