Fields

A API do X v2 retorna dados mínimos por padrão. Use parâmetros fields para solicitar dados adicionais para cada tipo de objeto.

Como os fields funcionam

Por padrão, uma consulta de post retorna apenas id, text e edit_history_tweet_ids. Para obter mais dados, adicione parâmetros de field à sua solicitação:

# Default response - minimal fields
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"

Parâmetros de field disponíveis

Cada tipo de objeto tem seu próprio parâmetro fields:

Objeto	Parâmetro	Documentação
Post (Tweet)	`tweet.fields`	Fields de Post
User	`user.fields`	Fields de User
Media	`media.fields`	Fields de Media
Poll	`poll.fields`	Fields de Poll
Place	`place.fields`	Fields de Place

Exemplo: fields de Post

Solicite fields específicos de post com tweet.fields:

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

Resposta:

Exemplo de resposta

{
  "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,
      "bookmark_count": 3,
      "impression_count": 1500
    }
  }
}

Exemplo: fields de User

Solicite fields específicos de user com user.fields:

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

Resposta:

Exemplo de resposta

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

Fields para objetos relacionados

Para obter fields em objetos relacionados (como o autor de um post), você precisa de duas coisas:

Uma expansion para incluir o objeto relacionado
O parâmetro fields para esse tipo de objeto

# Get post with author details
curl "https://api.x.com/2/tweets/1234567890?expansions=author_id&user.fields=description,public_metrics" \
  -H "Authorization: Bearer $TOKEN"

Resposta:

Exemplo de resposta

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

Saiba mais sobre expansions →

Combinações comuns de fields

Análise de posts
Perfis de usuário
Contexto completo do post
Detalhes de mídia

tweet.fields=created_at,public_metrics,possibly_sensitive

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

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

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

Observações importantes

Você não pode solicitar subfields. Ao solicitar public_metrics, você obtém todas as métricas (likes, reposts, replies, quotes, bookmarks, impressions). Não é possível solicitar apenas public_metrics.like_count.

A ordem dos fields nas respostas pode diferir da ordem da solicitação
Fields ausentes nas respostas significam que o valor é null ou vazio
Alguns fields exigem autenticação específica (ex.: métricas privadas precisam de user context)
Consulte a referência da API de cada endpoint para os fields disponíveis

Getting Started

Products

Fundamentals

Partners & Customers

Resources

Fields

Como os fields funcionam

Parâmetros de field disponíveis

Exemplo: fields de Post

Exemplo: fields de User

Fields para objetos relacionados

Combinações comuns de fields

Observações importantes

Próximos passos

Expansions

Dicionário de dados

​Como os fields funcionam

​Parâmetros de field disponíveis

​Exemplo: fields de Post

​Exemplo: fields de User

​Fields para objetos relacionados

​Combinações comuns de fields

​Observações importantes

​Próximos passos

Expansions

Dicionário de dados

Como os fields funcionam

Parâmetros de field disponíveis

Exemplo: fields de Post

Exemplo: fields de User

Fields para objetos relacionados

Combinações comuns de fields

Observações importantes

Próximos passos