Skip to main content
GET
/
2
/
usage
/
tweets
Get usage
curl --request GET \
  --url https://api.x.com/2/usage/tweets \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.x.com/2/usage/tweets"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.x.com/2/usage/tweets', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.x.com/2/usage/tweets",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.x.com/2/usage/tweets"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.x.com/2/usage/tweets")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.x.com/2/usage/tweets")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "data": {
    "cap_reset_day": 123,
    "daily_client_app_usage": [
      {
        "client_app_id": "<string>",
        "usage": [
          {
            "date": "2021-01-06T18:40:40.000Z",
            "usage": 123
          }
        ],
        "usage_result_count": 123
      }
    ],
    "daily_project_usage": {
      "project_id": 123,
      "usage": [
        {
          "date": "2021-01-06T18:40:40.000Z",
          "usage": 123
        }
      ]
    },
    "project_cap": 123,
    "project_id": "<string>",
    "project_usage": 123
  },
  "errors": [
    {
      "title": "<string>",
      "type": "<string>",
      "detail": "<string>",
      "status": 123
    }
  ]
}
{
  "code": 123,
  "message": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
days
integer<int32>
default:7

The number of days for which you need usage for.

Required range: 1 <= x <= 90
​
usage.fields
enum<string>[]

A comma separated list of Usage fields to display. The fields available for a Usage object.

Minimum array length: 1
Available options:
cap_reset_day,
daily_client_app_usage,
daily_project_usage,
project_cap,
project_id,
project_usage
Example:
[
  "cap_reset_day",
  "daily_client_app_usage",
  "daily_project_usage",
  "project_cap",
  "project_id",
  "project_usage"
]

Response

The request has succeeded.

​
data
object

Usage per client app

​
errors
object[]
Minimum array length: 1

An HTTP Problem Details object, as defined in IETF RFC 7807 (https://tools.ietf.org/html/rfc7807).