stophy-dev X API
The X API from stophy-dev — 3 operation(s) for x.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/stophy-dev:stophy-dev-x-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Stophy X API
version: '1'
description: 'Every endpoint is a POST that takes its input as a JSON object body. Unknown fields are rejected with 400.
Responses leave out empty values: null, empty strings, empty objects and empty nested lists are not sent.
Text comes back whole. To get shorter responses, add ?maxTextLength= to the URL. Every text value longer than that is cut and ends with …. A screenshot is never cut, and a page whose text was cut has isTruncated set to true.
x-credits is what one call costs. Every call costs the same, whatever it returns, unless an operation''s description says it costs per 10 results, or per second of audio. Then x-credits is the lowest price and x-credits-max the most one call can cost. Where an operation takes limit, send it to return fewer results and pay for fewer.
When a response has a cursor, send it back unchanged with the same input to get the next page. When it has a page, send the next page number.
Endpoints whose security includes {} also work without an API key: 10 requests a minute and 50 a day per IP, and no paging.'
servers:
- url: https://api.stophy.dev
security:
- apiKey: []
tags:
- name: X
paths:
/v1/x/profile:
post:
operationId: xProfile
summary: Scrape an X profile
description: Costs 1 credit per call. Works without an API key, within free limits.
security:
- {}
- apiKey: []
x-credits: 1
parameters:
- $ref: '#/components/parameters/MaxTextLength'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
profileUrl:
type: string
description: Link to the X profile, like https://x.com/nasa. Send this or username.
username:
type: string
description: X profile handle, like nasa. Send this or profileUrl.
sendOne:
- profileUrl
- username
additionalProperties: false
example:
username: nasa
responses:
'200':
description: The data, and the credits this call used.
headers:
X-Request-ID:
$ref: '#/components/headers/RequestId'
x-credits-used:
$ref: '#/components/headers/CreditsUsed'
X-RateLimit-Limit:
$ref: '#/components/headers/RateLimitLimit'
X-RateLimit-Remaining:
$ref: '#/components/headers/RateLimitRemaining'
X-RateLimit-Reset:
$ref: '#/components/headers/RateLimitReset'
x-cache:
$ref: '#/components/headers/Cache'
x-cache-age:
$ref: '#/components/headers/CacheAge'
content:
application/json:
schema:
type: object
required:
- success
- data
- creditsUsed
- requestId
properties:
success:
const: true
data:
type: object
additionalProperties: false
properties:
userId:
type: string
username:
type: string
profileUrl:
type: string
format: uri
name:
type: string
bio:
type: string
location:
type: string
website:
type: string
format: uri
joinedAt:
type: string
format: date-time
pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
followers:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
following:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
posts:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
isVerified:
type: boolean
verifiedType:
type: string
isProtected:
type: boolean
avatarUrl:
type: string
format: uri
bannerUrl:
type: string
format: uri
required:
- profileUrl
- isVerified
- isProtected
creditsUsed:
type: integer
requestId:
type: string
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- X
/v1/x/profile/posts:
post:
operationId: xProfilePosts
summary: Scrape an X profile's posts
description: Costs 1 credit per call. Pages with cursor.
x-credits: 1
parameters:
- $ref: '#/components/parameters/MaxTextLength'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
profileUrl:
type: string
description: Link to the X profile, like https://x.com/nasa. Send this or username.
username:
type: string
description: X profile handle, like nasa. Send this or profileUrl.
cursor:
type: string
minLength: 1
description: The cursor from the previous response. Send it as is.
sendOne:
- profileUrl
- username
additionalProperties: false
example:
username: nasa
responses:
'200':
description: The data, and the credits this call used.
headers:
X-Request-ID:
$ref: '#/components/headers/RequestId'
x-credits-used:
$ref: '#/components/headers/CreditsUsed'
X-RateLimit-Limit:
$ref: '#/components/headers/RateLimitLimit'
X-RateLimit-Remaining:
$ref: '#/components/headers/RateLimitRemaining'
X-RateLimit-Reset:
$ref: '#/components/headers/RateLimitReset'
x-cache:
$ref: '#/components/headers/Cache'
x-cache-age:
$ref: '#/components/headers/CacheAge'
content:
application/json:
schema:
type: object
required:
- success
- data
- creditsUsed
- requestId
properties:
success:
const: true
data:
type: object
additionalProperties: false
properties:
order:
type: string
enum:
- newest
- popular
description: newest is the profile's posts, newest first, paged with cursor. popular is the set of popular posts X shows for some profiles instead, all in one page.
results:
type: array
items:
type: object
additionalProperties: false
properties:
postId:
type: string
postUrl:
type: string
format: uri
text:
type: string
publishedAt:
type: string
format: date-time
pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
language:
type: string
likes:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
replies:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
reposts:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
quotes:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
bookmarks:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
views:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
authorId:
type: string
authorUsername:
type: string
authorName:
type: string
authorUrl:
type: string
format: uri
authorAvatarUrl:
type: string
format: uri
authorIsVerified:
type: boolean
media:
type: array
items:
type: object
additionalProperties: false
properties:
type:
type: string
enum:
- photo
- video
- gif
url:
type: string
format: uri
thumbnailUrl:
type: string
format: uri
width:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
height:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
durationSeconds:
type: number
altText:
type: string
required:
- type
- url
links:
type: array
items:
type: string
format: uri
hashtags:
type: array
items:
type: string
mentions:
type: array
items:
type: string
replyToUrl:
type: string
format: uri
quotedUrl:
type: string
format: uri
quotedText:
type: string
quotedAuthorUsername:
type: string
isEdited:
type: boolean
isSensitive:
type: boolean
isPinned:
type: boolean
isRepost:
type: boolean
required:
- postUrl
- isEdited
- isSensitive
- isPinned
- isRepost
cursor:
type: string
required:
- results
- order
creditsUsed:
type: integer
requestId:
type: string
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- X
/v1/x/post:
post:
operationId: xPost
summary: Scrape an X post
description: Costs 1 credit per call. Works without an API key, within free limits.
security:
- {}
- apiKey: []
x-credits: 1
parameters:
- $ref: '#/components/parameters/MaxTextLength'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
postUrl:
type: string
description: Link to the X post, like https://x.com/nasa/status/2107773105779167621. Send this or postId.
postId:
type: string
description: X post id, like 2107773105779167621. Send this or postUrl.
sendOne:
- postUrl
- postId
additionalProperties: false
example:
postId: '2107773105779167621'
responses:
'200':
description: The data, and the credits this call used.
headers:
X-Request-ID:
$ref: '#/components/headers/RequestId'
x-credits-used:
$ref: '#/components/headers/CreditsUsed'
X-RateLimit-Limit:
$ref: '#/components/headers/RateLimitLimit'
X-RateLimit-Remaining:
$ref: '#/components/headers/RateLimitRemaining'
X-RateLimit-Reset:
$ref: '#/components/headers/RateLimitReset'
x-cache:
$ref: '#/components/headers/Cache'
x-cache-age:
$ref: '#/components/headers/CacheAge'
content:
application/json:
schema:
type: object
required:
- success
- data
- creditsUsed
- requestId
properties:
success:
const: true
data:
type: object
additionalProperties: false
properties:
postId:
type: string
postUrl:
type: string
format: uri
text:
type: string
publishedAt:
type: string
format: date-time
pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
language:
type: string
likes:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
replies:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
reposts:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
quotes:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
bookmarks:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
views:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
authorId:
type: string
authorUsername:
type: string
authorName:
type: string
authorUrl:
type: string
format: uri
authorAvatarUrl:
type: string
format: uri
authorIsVerified:
type: boolean
media:
type: array
items:
type: object
additionalProperties: false
properties:
type:
type: string
enum:
- photo
- video
- gif
url:
type: string
format: uri
thumbnailUrl:
type: string
format: uri
width:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
height:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
durationSeconds:
type: number
altText:
type: string
required:
- type
- url
links:
type: array
items:
type: string
format: uri
hashtags:
type: array
items:
type: string
mentions:
type: array
items:
type: string
replyToUrl:
type: string
format: uri
quotedUrl:
type: string
format: uri
quotedText:
type: string
quotedAuthorUsername:
type: string
isEdited:
type: boolean
isSensitive:
type: boolean
required:
- postUrl
- media
- links
- hashtags
- mentions
- isEdited
- isSensitive
creditsUsed:
type: integer
requestId:
type: string
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- X
components:
headers:
RateLimitLimit:
description: Requests allowed in the current window.
schema:
type: integer
Cache:
description: hit if this result came from the cache, miss if it was fetched live.
schema:
type: string
RateLimitRemaining:
description: Requests left in the current window.
schema:
type: integer
CreditsUsed:
description: Credits this call used.
schema:
type: integer
CacheAge:
description: Seconds since the returned result was written to the cache.
schema:
type: integer
RateLimitReset:
description: Unix time in seconds when the current window resets.
schema:
type: integer
RequestId:
description: The request id. Quote it when you report a problem.
schema:
type: string
RetryAfter:
description: Seconds to wait before retrying.
schema:
type: integer
parameters:
MaxTextLength:
name: maxTextLength
in: query
required: false
description: Cut every text value in the response to this many characters. A value that was cut ends with …, and a page whose text was cut has isTruncated set to true. A screenshot is never cut. Leave it out to get the full text.
schema:
type: integer
minimum: 1
schemas:
Error:
type: object
required:
- success
- error
properties:
success:
const: false
error:
type: object
required:
- code
- message
- retryable
- requestId
properties:
code:
type: string
enum:
- cliSessionCompleted
- cliSessionExists
- cliSessionNotFound
- forbidden
- insufficientCredits
- internalError
- inviteClaimed
- inviteDisabled
- inviteExpired
- inviteUsedUp
- invalidCliSession
- invalidCliVerifier
- invalidRequest
- notFound
- rateLimited
- sourceChanged
- sourceRefused
- sourceTimeout
- sourceUnavailable
- unauthorized
- unsupportedMediaType
message:
type: string
retryable:
type: boolean
retryAfterSeconds:
type: integer
requestId:
type: string
requiredCredits:
type: number
availableCredits:
type: number
billingUrl:
type: string
const: https://stophy.dev/billing
responses:
Error:
description: The request failed. retryable says whether trying again can help.
headers:
X-Request-ID:
$ref: '#/components/headers/RequestId'
Retry-After:
$ref: '#/components/headers/RetryAfter'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
securitySchemes:
apiKey:
type: http
scheme: bearer