Skip to main content

Submódulos

Contenido del módulo

This module provides access to the posts endpoints of the X API and serves as the main entry point for all posts-related functionality.

class xdk.posts.PostsClient

Cliente para operaciones de posts

Parámetros

Client

__init__

Parámetros

Client

create

Crear o editar Post Crea un nuevo Post para el usuario autenticado, o edita un Post existente cuando se proporcionan edit_options. body: Cuerpo de la solicitud :returns: Datos de respuesta :rtype: CreateResponse

Parámetros

CreateRequest

delete

Eliminar Post Elimina un Post específico por su ID, si es propiedad del usuario autenticado.

Parámetros

Any
El ID del Post que se eliminará.

Devuelve

DeleteResponse - Response data

get_analytics

Obtener análisis del Post Recupera datos de análisis para los Posts especificados dentro de un rango de tiempo definido.

Parámetros

List
Una lista separada por comas de IDs de Post. Se permiten hasta 100 en una sola solicitud.
str
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC que representa el final del rango de tiempo.
str
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC que representa el inicio del rango de tiempo.
str
La granularidad para los resultados de conteos de búsqueda.
List or None
default:"None"
Una lista separada por comas de campos de Analytics a mostrar.

Devuelve

GetAnalyticsResponse - Response data

get_by_id

Obtener Post por ID Recupera los detalles de un Post específico por su ID.

Parámetros

Any
Un único ID de Post.
List or None
default:"None"
Una lista separada por comas de campos de Tweet a mostrar.
List or None
default:"None"
Una lista separada por comas de campos para expandir.
List or None
default:"None"
Una lista separada por comas de campos de Media a mostrar.
List or None
default:"None"
Una lista separada por comas de campos de Poll a mostrar.
List or None
default:"None"
Una lista separada por comas de campos de User a mostrar.
List or None
default:"None"
Una lista separada por comas de campos de Place a mostrar.

Devuelve

GetByIdResponse - Response data

get_by_ids

Obtener Posts por IDs Recupera los detalles de varios Posts por sus IDs.

Parámetros

List
Una lista separada por comas de IDs de Post. Se permiten hasta 100 en una sola solicitud.
List or None
default:"None"
Una lista separada por comas de campos de Tweet a mostrar.
List or None
default:"None"
Una lista separada por comas de campos para expandir.
List or None
default:"None"
Una lista separada por comas de campos de Media a mostrar.
List or None
default:"None"
Una lista separada por comas de campos de Poll a mostrar.
List or None
default:"None"
Una lista separada por comas de campos de User a mostrar.
List or None
default:"None"
Una lista separada por comas de campos de Place a mostrar.

Devuelve

GetByIdsResponse - Response data

get_counts_all

Get count of all Posts Retrieves the count of Posts matching a search query from the full archive.

Parámetros

str
One query/rule/filter for matching Posts. Refer to https://t.co/rulelength to identify the max query length.
str or None
default:"None"
YYYY-MM-DDTHH:mm:ssZ. The oldest UTC timestamp (from most recent 7 days) from which the Posts will be provided. Timestamp is in second granularity and is inclusive (i.e. 12:00:01 includes the first second of the minute).
str or None
default:"None"
YYYY-MM-DDTHH:mm:ssZ. The newest, most recent UTC timestamp to which the Posts will be provided. Timestamp is in second granularity and is exclusive (i.e. 12:00:01 excludes the first second of the minute).
Any or None
default:"None"
Returns results with a Post ID greater than (that is, more recent than) the specified ID.
Any or None
default:"None"
Returns results with a Post ID less than (that is, older than) the specified ID.
Any or None
default:"None"
This parameter is used to get the next ‘page’ of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified.
Any or None
default:"None"
This parameter is used to get the next ‘page’ of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified.
str or None
default:"None"
La granularidad para los resultados de conteos de búsqueda.
List or None
default:"None"
A comma separated list of SearchCount fields to display.

Devuelve

IteratorGetCountsAllResponse

get_counts_recent

Get count of recent Posts Retrieves the count of Posts from the last 7 days matching a search query.

Parámetros

str
One query/rule/filter for matching Posts. Refer to https://t.co/rulelength to identify the max query length.
str or None
default:"None"
YYYY-MM-DDTHH:mm:ssZ. The oldest UTC timestamp (from most recent 7 days) from which the Posts will be provided. Timestamp is in second granularity and is inclusive (i.e. 12:00:01 includes the first second of the minute).
str or None
default:"None"
YYYY-MM-DDTHH:mm:ssZ. The newest, most recent UTC timestamp to which the Posts will be provided. Timestamp is in second granularity and is exclusive (i.e. 12:00:01 excludes the first second of the minute).
Any or None
default:"None"
Returns results with a Post ID greater than (that is, more recent than) the specified ID.
Any or None
default:"None"
Returns results with a Post ID less than (that is, older than) the specified ID.
Any or None
default:"None"
This parameter is used to get the next ‘page’ of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified.
Any or None
default:"None"
This parameter is used to get the next ‘page’ of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified.
str or None
default:"None"
La granularidad para los resultados de conteos de búsqueda.
List or None
default:"None"
A comma separated list of SearchCount fields to display.

Devuelve

IteratorGetCountsRecentResponse

get_insights28hr

Get 28-hour Post insights Retrieves engagement metrics for specified Posts over the last 28 hours.

Parámetros

List
List of PostIds for 28hr metrics.
str
granularity of metrics response.
List
request metrics for historical request.
List or None
default:"None"
A comma separated list of Engagement fields to display.

Devuelve

GetInsights28hrResponse - Response data

get_insights_historical

Get historical Post insights Retrieves historical engagement metrics for specified Posts within a defined time range.

Parámetros

List
List of PostIds for historical metrics.
str
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC que representa el final del rango de tiempo.
str
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC que representa el inicio del rango de tiempo.
str
granularity of metrics response.
List
request metrics for historical request.
List or None
default:"None"
A comma separated list of Engagement fields to display.

Devuelve

GetInsightsHistoricalResponse - Response data

get_liking_users

Get Liking Users Retrieves a list of Users who liked a specific Post by its ID.

Parámetros

Any
Un único ID de Post.
int or None
default:"None"
El número máximo de resultados.
Any or None
default:"None"
This parameter is used to get the next ‘page’ of results.
List or None
default:"None"
Una lista separada por comas de campos de User a mostrar.
List or None
default:"None"
Una lista separada por comas de campos para expandir.
List or None
default:"None"
Una lista separada por comas de campos de Tweet a mostrar.

Devuelve

IteratorGetLikingUsersResponse

get_quoted

Get Quoted Posts Retrieves a list of Posts that quote a specific Post by its ID.

Parámetros

Any
Un único ID de Post.
int or None
default:"None"
The maximum number of results to be returned.
Any or None
default:"None"
This parameter is used to get a specified ‘page’ of results.
List or None
default:"None"
The set of entities to exclude (e.g. ‘replies’ or ‘retweets’).
List or None
default:"None"
Una lista separada por comas de campos de Tweet a mostrar.
List or None
default:"None"
Una lista separada por comas de campos para expandir.
List or None
default:"None"
Una lista separada por comas de campos de Media a mostrar.
List or None
default:"None"
Una lista separada por comas de campos de Poll a mostrar.
List or None
default:"None"
Una lista separada por comas de campos de User a mostrar.
List or None
default:"None"
Una lista separada por comas de campos de Place a mostrar.

Devuelve

IteratorGetQuotedResponse

get_reposted_by

Get Reposted by Retrieves a list of Users who reposted a specific Post by its ID.

Parámetros

Any
Un único ID de Post.
int or None
default:"None"
El número máximo de resultados.
Any or None
default:"None"
This parameter is used to get the next ‘page’ of results.
List or None
default:"None"
Una lista separada por comas de campos de User a mostrar.
List or None
default:"None"
Una lista separada por comas de campos para expandir.
List or None
default:"None"
Una lista separada por comas de campos de Tweet a mostrar.

Devuelve

IteratorGetRepostedByResponse

get_reposts

Get Reposts Retrieves a list of Posts that repost a specific Post by its ID.

Parámetros

Any
Un único ID de Post.
int or None
default:"None"
El número máximo de resultados.
Any or None
default:"None"
This parameter is used to get the next ‘page’ of results.
List or None
default:"None"
Una lista separada por comas de campos de Tweet a mostrar.
List or None
default:"None"
Una lista separada por comas de campos para expandir.
List or None
default:"None"
Una lista separada por comas de campos de Media a mostrar.
List or None
default:"None"
Una lista separada por comas de campos de Poll a mostrar.
List or None
default:"None"
Una lista separada por comas de campos de User a mostrar.
List or None
default:"None"
Una lista separada por comas de campos de Place a mostrar.

Devuelve

IteratorGetRepostsResponse

hide_reply

Hide reply Hides or unhides a reply to a conversation owned by the authenticated user.

Parámetros

Any
The ID of the reply that you want to hide or unhide.
HideReplyRequest
Request body

search_all

Search all Posts Retrieves Posts from the full archive matching a search query.

Parámetros

str
One query/rule/filter for matching Posts. Refer to https://t.co/rulelength to identify the max query length.
str or None
default:"None"
YYYY-MM-DDTHH:mm:ssZ. The oldest UTC timestamp from which the Posts will be provided. Timestamp is in second granularity and is inclusive (i.e. 12:00:01 includes the first second of the minute).
str or None
default:"None"
YYYY-MM-DDTHH:mm:ssZ. The newest, most recent UTC timestamp to which the Posts will be provided. Timestamp is in second granularity and is exclusive (i.e. 12:00:01 excludes the first second of the minute).
Any or None
default:"None"
Returns results with a Post ID greater than (that is, more recent than) the specified ID.
Any or None
default:"None"
Returns results with a Post ID less than (that is, older than) the specified ID.
int or None
default:"None"
The maximum number of search results to be returned by a request.
Any or None
default:"None"
This parameter is used to get the next ‘page’ of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified.
Any or None
default:"None"
This parameter is used to get the next ‘page’ of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified.
str or None
default:"None"
This order in which to return results.
List or None
default:"None"
Una lista separada por comas de campos de Tweet a mostrar.
List or None
default:"None"
Una lista separada por comas de campos para expandir.
List or None
default:"None"
Una lista separada por comas de campos de Media a mostrar.
List or None
default:"None"
Una lista separada por comas de campos de Poll a mostrar.
List or None
default:"None"
Una lista separada por comas de campos de User a mostrar.
List or None
default:"None"
Una lista separada por comas de campos de Place a mostrar.

Devuelve

IteratorSearchAllResponse

search_recent

Search recent Posts Retrieves Posts from the last 7 days matching a search query.

Parámetros

str
One query/rule/filter for matching Posts. Refer to https://t.co/rulelength to identify the max query length.
str or None
default:"None"
YYYY-MM-DDTHH:mm:ssZ. The oldest UTC timestamp from which the Posts will be provided. Timestamp is in second granularity and is inclusive (i.e. 12:00:01 includes the first second of the minute).
str or None
default:"None"
YYYY-MM-DDTHH:mm:ssZ. The newest, most recent UTC timestamp to which the Posts will be provided. Timestamp is in second granularity and is exclusive (i.e. 12:00:01 excludes the first second of the minute).
Any or None
default:"None"
Returns results with a Post ID greater than (that is, more recent than) the specified ID.
Any or None
default:"None"
Returns results with a Post ID less than (that is, older than) the specified ID.
int or None
default:"None"
The maximum number of search results to be returned by a request.
Any or None
default:"None"
This parameter is used to get the next ‘page’ of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified.
Any or None
default:"None"
This parameter is used to get the next ‘page’ of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified.
str or None
default:"None"
This order in which to return results.
List or None
default:"None"
Una lista separada por comas de campos de Tweet a mostrar.
List or None
default:"None"
Una lista separada por comas de campos para expandir.
List or None
default:"None"
Una lista separada por comas de campos de Media a mostrar.
List or None
default:"None"
Una lista separada por comas de campos de Poll a mostrar.
List or None
default:"None"
Una lista separada por comas de campos de User a mostrar.
List or None
default:"None"
Una lista separada por comas de campos de Place a mostrar.

Devuelve

IteratorSearchRecentResponse