Skip to content

Get-TwitterRateLimitStatus

SYNOPSIS

Returns the current rate limits for methods belonging to the specified resource families.

SYNTAX

Get-TwitterRateLimitStatus [[-Resources] <String[]>] [<CommonParameters>]

DESCRIPTION

Returns the current rate limits for methods belonging to the specified resource families.

EXAMPLES

Example 1

PS > Get-TwitterRateLimitStatus

Returns the current rate limits for all resources.

Example 2

PS > Get-TwitterRateLimitStatus -Resources friends | ConvertTo-Json
{
  "friends": {
    "/friends/following/ids": {
      "limit": 15,
      "remaining": 15,
      "reset": 1606013805
    },
    "/friends/following/list": {
      "limit": 15,
      "remaining": 15,
      "reset": 1606013805
    },
    "/friends/list": {
      "limit": 15,
      "remaining": 15,
      "reset": 1606013805
    },
    "/friends/ids": {
      "limit": 15,
      "remaining": 15,
      "reset": 1606013805
    }
  }
}

Returns the current rate limits for the friends resource.

The output was converted to JSON for easier readability.

PARAMETERS

-Resources

A comma-separated list of resource families you want to know the current rate limit disposition for.

For best performance, only specify the resource families pertinent to your application.

See API Rate Limiting for more information.

Type: String[]
Parameter Sets: (All)
Aliases:
Accepted values: lists, application, mutes, live_video_stream, friendships, guide, auth, blocks, geo, users, teams, followers, collections, statuses, custom_profiles, webhooks, contacts, labs, i, tweet_prompts, moments, limiter_scalding_report_creation, fleets, help, feedback, business_experience, graphql&POST, friends, sandbox, drafts, direct_messages, media, traffic, account_activity, account, safety, favorites, device, tweets, saved_searches, oauth, search, trends, live_pipeline, graphql

Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None

OUTPUTS

System.Object

NOTES

Online Version

Api Reference - GET application/rate_limit_status