X (Twitter) Compliance API is one of 23 APIs that X (Twitter) publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Compliance. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, an API reference, authentication docs, and rate-limit docs.
This API exposes
7 operations
across 6 paths,
and defines 54 schemas.
It is described by OpenAPI 3.0.0, at version 2.161.
Requests are made against a single base URL, https://api.x.com.
7 operations6 paths54 schemas6 GET1 POST
Metadata
The identity and technical contract details declared by the specification.
X (Twitter) Compliance API declares
3 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (BearerToken).
It supports OAuth 2.0 (OAuth2UserToken) using the authorizationCode flow, exposing 21 scopes.
It uses HTTP oauth authentication (UserToken).
Paths & Operations 7
Across 6 paths, the API surfaces 7 operations — 6 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Compliance 7
Endpoints related to keeping X data in your systems compliant
GET
/2/compliance/jobs
X Get Compliance Jobs
getComplianceJobs3 params→ 200default
POST
/2/compliance/jobs
X Create Compliance Job
createComplianceJobsbody→ 200default
GET
/2/compliance/jobs/{id}
X Get Compliance Job by ID
getComplianceJobsById2 params→ 200default
GET
/2/likes/compliance/stream
X Stream Likes Compliance Data
streamLikesCompliance3 params→ 200default
GET
/2/tweets/compliance/stream
X Stream Posts Compliance Data
streamPostsCompliance4 params→ 200default
GET
/2/tweets/label/stream
X Stream Post Labels
streamLabelsCompliance3 params→ 200default
GET
/2/users/compliance/stream
X Stream Users Compliance Data
streamUsersCompliance4 params→ 200default
Schemas 54
The contract defines 54 schemas that model the data the API accepts and returns. The most detailed are ComplianceJob (9 properties), TweetNotice (7 properties), TweetEditComplianceObjectSchema (4 properties), UserProfileModificationObjectSchema (4 properties). Each schema is shown below with its type and property counts.
TweetNotice
object
7 properties4 required
UnlikeComplianceSchema
object
2 properties2 required
UserScrubGeoObjectSchema
object
3 properties3 required
TweetLabelStreamResponse
Tweet label stream events.
UserProtectComplianceSchema
object
1 property1 required
LikeComplianceSchema
object
1 property1 required
CreateComplianceJobRequest
object
A request to create a new batch compliance job.
3 properties1 required
ComplianceJobStatus
string
Status of a compliance job.
TweetWithheldComplianceSchema
object
1 property1 required
DownloadUrl
string
URL from which the user will retrieve their compliance results.
LikesComplianceStreamResponse
Likes compliance stream events.
TweetEditComplianceSchema
object
1 property1 required
TweetComplianceSchema
object
3 properties2 required
UserSuspendComplianceSchema
object
1 property1 required
TweetUnviewableSchema
object
1 property1 required
ComplianceJobType
string
Type of compliance job to list.
ComplianceJobName
string
User-provided name for a compliance job.
UserUnprotectComplianceSchema
object
1 property1 required
TweetEditComplianceObjectSchema
object
4 properties4 required
JobId
string
Compliance Job ID.
ComplianceJob
object
9 properties8 required
TweetLabelData
Tweet label data.
TweetTakedownComplianceSchema
object
4 properties3 required
TweetComplianceStreamResponse
Tweet compliance stream events.
CreateComplianceJobResponse
object
2 properties
UserUnsuspendComplianceSchema
object
1 property1 required
TweetId
string
Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.
TweetComplianceData
Tweet compliance data.
Error
object
2 properties2 required
CreatedAt
string
Creation time of the compliance job.
Get2ComplianceJobsResponse
object
3 properties
UserComplianceStreamResponse
User compliance stream events.
ResultCount
integer
The number of results returned in this response.
UserUndeleteComplianceSchema
object
1 property1 required
CountryCode
string
A two-letter ISO 3166-1 alpha-2 country code.
DownloadExpiration
string
Expiration time of the download URL.
TweetUnviewable
object
3 properties3 required
TweetNoticeSchema
object
1 property1 required
UserWithheldComplianceSchema
object
1 property1 required
TweetUndropComplianceSchema
object
1 property1 required
UploadExpiration
string
Expiration time of the upload URL.
TweetDeleteComplianceSchema
object
1 property1 required
UserComplianceData
User compliance data.
Problem
object
An HTTP Problem Details object, as defined in IETF RFC 7807 (https://tools.ietf.org/html/rfc7807).
4 properties2 required
UserComplianceSchema
object
2 properties2 required
UserScrubGeoSchema
object
1 property1 required
Get2ComplianceJobsIdResponse
object
2 properties
UserDeleteComplianceSchema
object
1 property1 required
UserTakedownComplianceSchema
object
3 properties3 required
UserProfileModificationObjectSchema
object
4 properties4 required
UserId
string
Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.
UploadUrl
string
URL to which the user will upload their Tweet or user IDs.
UserProfileModificationComplianceSchema
object
1 property1 required
TweetDropComplianceSchema
object
1 property1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
