> ## 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.
# 퀵스타트
> 이 가이드는 filtered stream에 연결하여 거의 실시간으로 게시물을 수신하는 방법을 안내합니다. filtered stream을 다루는 X API v2 standard 티어 레퍼런스입니다.
export const Button = ({href, children}) => {
return ;
};
이 가이드는 filtered stream에 연결하여 필터 규칙과 매칭되는 게시물을 거의 실시간으로 수신하는 방법을 안내합니다.
**사전 요구사항**
시작하기 전에 다음이 필요합니다:
* [developer account](https://developer.x.com/en/portal/petition/essential/basic-info)
* App의 Bearer Token(Developer Console의 "Keys and tokens"에서 확인)
***
규칙은 어떤 게시물을 수신할지 정의합니다. keywords, hashtags, users 등을 매칭하는 데 연산자를 사용하세요.
**예시 규칙:** 이미지가 포함된 "cat" 게시물 매칭:
```
cat has:images
```
규칙 구문 및 연산자 익히기
rules 엔드포인트를 사용해 규칙을 추가합니다. 각 게시물이 어떤 규칙에 매칭됐는지 식별할 수 있도록 `tag`를 포함하세요:
```bash cURL theme={null}
curl -X POST "https://api.x.com/2/tweets/search/stream/rules" \
-H "Authorization: Bearer $BEARER_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"add": [
{"value": "cat has:images", "tag": "cats with images"}
]
}'
```
```python Python SDK theme={null}
from xdk import Client
client = Client(bearer_token="YOUR_BEARER_TOKEN")
# Add a rule to the filtered stream
response = client.filtered_stream.add_rules(
add=[{"value": "cat has:images", "tag": "cats with images"}]
)
for rule in response.data:
print(f"Rule added: {rule.id} - {rule.value}")
```
```javascript title="JavaScript SDK" lines wrap icon="square-js" theme={null}
import { Client } from "@xdevplatform/xdk";
const client = new Client({ bearerToken: "YOUR_BEARER_TOKEN" });
// Add a rule to the filtered stream
const response = await client.filteredStream.addRules({
add: [{ value: "cat has:images", tag: "cats with images" }],
});
response.data?.forEach((rule) => {
console.log(`Rule added: ${rule.id} - ${rule.value}`);
});
```
**응답:**
```json theme={null}
{
"data": [
{
"id": "1273026480692322304",
"value": "cat has:images",
"tag": "cats with images"
}
],
"meta": {
"sent": "2024-01-15T10:30:00.000Z",
"summary": {
"created": 1,
"not_created": 0,
"valid": 1,
"invalid": 0
}
}
}
```
활성 규칙을 모두 나열하여 규칙이 추가되었는지 확인합니다:
```bash cURL theme={null}
curl "https://api.x.com/2/tweets/search/stream/rules" \
-H "Authorization: Bearer $BEARER_TOKEN"
```
```python Python SDK theme={null}
from xdk import Client
client = Client(bearer_token="YOUR_BEARER_TOKEN")
# Get all active rules
response = client.filtered_stream.get_rules()
for rule in response.data:
print(f"Active rule: {rule.id} - {rule.value}")
```
```javascript JavaScript SDK theme={null}
import { Client } from "@xdevplatform/xdk";
const client = new Client({ bearerToken: "YOUR_BEARER_TOKEN" });
// Get all active rules
const response = await client.filteredStream.getRules();
response.data?.forEach((rule) => {
console.log(`Active rule: ${rule.id} - ${rule.value}`);
});
```
매칭 게시물을 수신하기 위해 지속적인 연결을 엽니다:
```bash cURL theme={null}
curl "https://api.x.com/2/tweets/search/stream?\
tweet.fields=created_at,author_id&\
expansions=author_id&\
user.fields=username" \
-H "Authorization: Bearer $BEARER_TOKEN"
```
```python title="Python SDK" lines wrap icon="python" theme={null}
from xdk import Client
client = Client(bearer_token="YOUR_BEARER_TOKEN")
# Connect to the filtered stream
for post in client.filtered_stream.stream(
tweet_fields=["created_at", "author_id"],
expansions=["author_id"],
user_fields=["username"]
):
print(f"New post: {post.data.text}")
print(f"Matching rules: {post.matching_rules}")
```
```javascript title="JavaScript SDK" lines wrap icon="square-js" theme={null}
import { Client } from "@xdevplatform/xdk";
const client = new Client({ bearerToken: "YOUR_BEARER_TOKEN" });
// Connect to the filtered stream
const stream = client.filteredStream.stream({
tweetFields: ["created_at", "author_id"],
expansions: ["author_id"],
userFields: ["username"],
});
for await (const post of stream) {
console.log(`New post: ${post.data?.text}`);
console.log(`Matching rules: ${post.matching_rules}`);
}
```
매칭 게시물은 JSON 객체로 스트리밍됩니다:
```json theme={null}
{
"data": {
"id": "1234567890",
"text": "Look at this cute cat! 🐱",
"author_id": "9876543210",
"created_at": "2024-01-15T10:35:00.000Z",
"edit_history_tweet_ids": ["1234567890"]
},
"includes": {
"users": [
{
"id": "9876543210",
"username": "catperson"
}
]
},
"matching_rules": [
{
"id": "1273026480692322304",
"tag": "cats with images"
}
]
}
```
`matching_rules` 배열은 정의한 tag를 사용해 어떤 규칙이 게시물에 매칭되었는지 보여줍니다.
ID로 규칙을 제거합니다:
```bash cURL theme={null}
curl -X POST "https://api.x.com/2/tweets/search/stream/rules" \
-H "Authorization: Bearer $BEARER_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"delete": {
"ids": ["1273026480692322304"]
}
}'
```
```python Python SDK theme={null}
from xdk import Client
client = Client(bearer_token="YOUR_BEARER_TOKEN")
# Delete rules by ID
response = client.filtered_stream.delete_rules(
delete={"ids": ["1273026480692322304"]}
)
print(f"Deleted: {response.meta.summary.deleted}")
```
```javascript JavaScript SDK theme={null}
import { Client } from "@xdevplatform/xdk";
const client = new Client({ bearerToken: "YOUR_BEARER_TOKEN" });
// Delete rules by ID
const response = await client.filteredStream.deleteRules({
delete: { ids: ["1273026480692322304"] },
});
console.log(`Deleted: ${response.meta?.summary?.deleted}`);
```
***
## 연결 관리
스트림은 20초마다 빈 줄(`\r\n`)을 보냅니다. 20초 동안 데이터나 keep-alive를 수신하지 않으면 재연결하세요.
연결을 닫으려면 `Ctrl+C`를 누르거나 터미널 창을 닫으세요.
App당 하나의 연결만 허용됩니다. 새 연결을 열면 기존 연결이 닫힙니다.
***
## 다음 단계
규칙 구문 익히기
사용 가능한 모든 연산자
원활하게 재연결하기
전체 엔드포인트 문서