Champs

Demander des champs de données spécifiques dans les réponses de l’API

La X API v2 renvoie par défaut un volume minimal de données. Utilisez les paramètres fields pour demander des données supplémentaires pour chaque type d’objet.

---

Fonctionnement des champs

Par défaut, une recherche de publication renvoie uniquement id, text et edit_history_tweet_ids. Pour obtenir davantage de données, ajoutez des paramètres de champs à votre requête :

# Réponse par défaut - champs minimaux
curl "https://api.x.com/2/tweets/1234567890" \
  -H "Authorization: Bearer $TOKEN"

# With additional fields
curl "https://api.x.com/2/tweets/1234567890?tweet.fields=created_at,public_metrics,author_id" \
  -H "Authorization: Bearer $TOKEN"

---

Paramètres de champs disponibles

Chaque type d’objet a son propre paramètre de champs :

Objet	Paramètre	Documentation
Publication (Tweet)	tweet.fields	Champs de publication
Utilisateur	user.fields	Champs d’utilisateur
Média	media.fields	Champs de média
Sondage	poll.fields	Champs de sondage
Lieu	place.fields	Champs de lieu

---

Exemple : champs de Publication

Demandez des champs spécifiques de Publication avec tweet.fields :

curl "https://api.x.com/2/tweets/1234567890?tweet.fields=created_at,public_metrics,lang" \
  -H "Authorization: Bearer $TOKEN"

Réponse :

{
  "data": {
    "id": "1234567890",
    "text": "Hello world!",
    "edit_history_tweet_ids": ["1234567890"],
    "created_at": "2024-01-15T12:00:00.000Z",
    "lang": "en",
    "public_metrics": {
      "retweet_count": 10,
      "reply_count": 5,
      "like_count": 100,
      "quote_count": 2
    }
  }
}

---

Exemple : champs utilisateur

Demandez des champs utilisateur spécifiques à l’aide de user.fields :

curl "https://api.x.com/2/users/by/username/xdevelopers?user.fields=created_at,description,public_metrics" \
  -H "Authorization: Bearer $TOKEN"

Réponse :

{
  "data": {
    "id": "2244994945",
    "name": "X Developers",
    "username": "xdevelopers",
    "created_at": "2013-12-14T04:35:55.000Z",
    "description": "The voice of the X Developer Platform",
    "public_metrics": {
      "followers_count": 570842,
      "following_count": 2048,
      "tweet_count": 14052,
      "listed_count": 1672
    }
  }
}

---

Champs pour les objets associés

Pour obtenir les champs des objets associés (comme l’auteur d’une publication), vous avez besoin de deux choses :

1. Une expansion pour inclure l’objet associé
2. Le paramètre fields pour ce type d’objet

# Récupérer une publication avec les détails de l'auteur
curl "https://api.x.com/2/tweets/1234567890?expansions=author_id&user.fields=description,public_metrics" \
  -H "Authorization: Bearer $TOKEN"

Réponse :

{
  "data": {
    "id": "1234567890",
    "text": "Hello world!",
    "author_id": "2244994945"
  },
  "includes": {
    "users": [{
      "id": "2244994945",
      "name": "X Developers",
      "username": "xdevelopers",
      "description": "The voice of the X Developer Platform",
      "public_metrics": {
        "followers_count": 570842,
        "following_count": 2048
      }
    }]
  }
}

En savoir plus sur Expansions →

---

Combinaisons de champs courantes

Statistiques de publication

tweet.fields=created_at,public_metrics,possibly_sensitive

Profils utilisateur

user.fields=created_at,description,location,public_metrics,verified

Contexte complet de la publication

tweet.fields=created_at,author_id,conversation_id,in_reply_to_user_id,referenced_tweets
expansions=author_id,referenced_tweets.id
user.fields=username,name

Détails des médias

tweet.fields=attachments
expansions=attachments.media_keys
media.fields=url,preview_image_url,alt_text,public_metrics

---

Notes importantes

Vous ne pouvez pas demander de sous-champs. Lorsque vous demandez public_metrics, vous obtenez toutes les métriques (mentions J’aime, republications, réponses, citations). Vous ne pouvez pas demander uniquement public_metrics.like_count.

• L’ordre des champs dans les réponses peut différer de l’ordre des champs dans la requête
• Des champs manquants dans les réponses signifient que la valeur est null ou vide
• Certains champs nécessitent une authentification spécifique (par exemple, les métriques privées requièrent un contexte utilisateur)
• Consultez la Référence de l’API de chaque endpoint pour connaître les champs disponibles

---

Prochaines étapes

Expansions

Incluez les objets associés dans les réponses.

Data Dictionary

Référence complète des champs de tous les objets.