Skip to main content
GET
/
2
/
connections
Get Connection History
curl --request GET \
  --url https://api.x.com/2/connections \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "connected_at": "2023-11-07T05:31:56Z",
      "endpoint_name": "sample_stream",
      "client_ip": "<string>",
      "disconnect_reason": "operator_disconnect",
      "disconnected_at": "2023-11-07T05:31:56Z"
    }
  ],
  "errors": [
    {
      "title": "<string>",
      "type": "<string>",
      "detail": "<string>",
      "status": 123
    }
  ],
  "meta": {
    "next_token": "<string>",
    "result_count": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.x.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
status
enum<string>
default:active

Filter by connection status. Use 'active' for current connections, 'inactive' for historical/disconnected connections, or 'all' for both.

Available options:
active,
inactive,
all
​
endpoints
enum<string>[]

Filter by streaming endpoint. Specify one or more endpoint names to filter results.

Available options:
filtered_stream,
sample_stream,
sample10_stream,
firehose_stream,
tweets_compliance_stream,
users_compliance_stream,
tweet_label_stream,
firehose_stream_lang_en,
firehose_stream_lang_ja,
firehose_stream_lang_ko,
firehose_stream_lang_pt,
likes_firehose_stream,
likes_sample10_stream,
likes_compliance_stream
​
max_results
integer<int32>
default:10

The maximum number of results to return per page.

Required range: 1 <= x <= 100
​
pagination_token
string

Token for paginating through results. Use the value from 'next_token' in the previous response.

​
connection.fields
enum<string>[]

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

Minimum array length: 1
Available options:
client_ip,
connected_at,
disconnect_reason,
disconnected_at,
endpoint_name,
id
Example:
[
  "client_ip",
  "connected_at",
  "disconnect_reason",
  "disconnected_at",
  "endpoint_name",
  "id"
]

Response

The request has succeeded.

​
data
object[]
Minimum array length: 1
​
errors
object[]
Minimum array length: 1

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

​
meta
object