Get Connection History

Returns active and historical streaming connections with disconnect reasons for the authenticated application.

GET /2/connections

Get Connection History

cURL

curl --request GET \
  --url https://api.x.com/2/connections \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.x.com/2/connections"

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/connections', 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/connections",
  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/connections"

	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/connections")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

200

{
  "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
  }
}

{
  "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

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

200

application/json

The request has succeeded.

data · object[]

Minimum array length: 1

Show child attributes

errors · object[]

Minimum array length: 1

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

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Option 7

Option 8

Option 9

Option 10

Option 11

Option 12

Option 13

Option 14

Option 15

Option 16

Option 17

Option 18

Show child attributes

meta · object

Show child attributes