{"openapi":"3.1.0","info":{"title":"SocialScrape API","version":"1","description":"Public social media data as an API: profiles, posts, comments, search, ads and transcripts across platforms, in one response shape.\n\nAuthenticate with the `x-api-key` header. Every response is an envelope with `ok`, `credits_charged`, `credits_remaining`, `cached`, `cached_at` and `request_id`; failures are free and carry a stable `error.code` and a `retryable` flag. Send `Idempotency-Key` on a retried POST to get the first answer back without a second charge. Pass `max_age_days` (or ScrapeCreators' `cache_max_age=7d`) to accept a cached result for free."},"servers":[{"url":"https://api.socialscrape.dev"}],"security":[{"ApiKeyAuth":[]}],"tags":[{"name":"youtube"},{"name":"tiktok"},{"name":"instagram"},{"name":"reddit"},{"name":"bluesky"},{"name":"threads"},{"name":"truthsocial"},{"name":"pinterest"},{"name":"twitch"},{"name":"kick"},{"name":"snapchat"},{"name":"linktree"},{"name":"komi"},{"name":"pillar"},{"name":"linkbio"},{"name":"linkme"},{"name":"web"},{"name":"facebook"},{"name":"google"},{"name":"linkedin"},{"name":"twitter"},{"name":"amazon"},{"name":"spotify"},{"name":"apple_music"},{"name":"soundcloud"},{"name":"github"},{"name":"kwai"},{"name":"rumble"},{"name":"telegram"},{"name":"cosmos"},{"name":"account"}],"paths":{"/v1/youtube/channel":{"get":{"operationId":"youtube.channel","summary":"YouTube channel details","tags":["youtube"],"parameters":[{"name":"handle","in":"query","required":false,"description":"Channel handle, with or without @.","schema":{"type":"string"},"x-aliases":["username"]},{"name":"id","in":"query","required":false,"description":"Channel id (UC...).","schema":{"type":"string"},"x-aliases":["channelId","channel_id"]},{"name":"url","in":"query","required":false,"description":"Any channel URL (/@handle, /channel/UC..., /c/name).","schema":{"type":"string","format":"uri"},"x-hosts":["youtube.com","youtu.be"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Profile_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"youtube.channel","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"youtube","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Name, avatar, subscribers, video and view counts, join date, country and linked links. Pass a `handle`, an `id` (channelId) or a channel `url`.","x-one-of":[["handle","id","url"]],"x-examples":[{"handle":"MrBeast"}]}},"/v1/youtube/channel/videos":{"get":{"operationId":"youtube.channel.videos","summary":"YouTube channel videos","tags":["youtube"],"parameters":[{"name":"handle","in":"query","required":false,"description":"Channel handle, with or without @.","schema":{"type":"string"},"x-aliases":["username"]},{"name":"id","in":"query","required":false,"description":"Channel id (UC...).","schema":{"type":"string"},"x-aliases":["channelId","channel_id"]},{"name":"url","in":"query","required":false,"description":"Any channel URL (/@handle, /channel/UC..., /c/name).","schema":{"type":"string","format":"uri"},"x-hosts":["youtube.com","youtu.be"]},{"name":"sort","in":"query","required":false,"description":"Order of results. Changing it restarts the cursor chain.","schema":{"type":"string","enum":["latest","popular"],"default":"latest"},"x-aliases":["sort_by","sortBy","order"],"x-value-aliases":{"newest":"latest"}},{"name":"include_extras","in":"query","required":false,"description":"Also fetch likes, comment count and description per video (slower, more errors). The video endpoint returns everything.","schema":{"type":"boolean","default":false},"x-aliases":["includeExtras"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"youtube.channel.videos","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"youtube","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"A channel's uploads, newest first or most popular. Page with `cursor` (the continuationToken).","x-one-of":[["handle","id","url"]],"x-examples":[{"handle":"MrBeast"}],"x-aliases":["/v1/youtube/channel-videos"]}},"/v1/youtube/channel/search":{"get":{"operationId":"youtube.channel.search","summary":"Search inside a YouTube channel","tags":["youtube"],"parameters":[{"name":"handle","in":"query","required":false,"description":"Channel handle, with or without @.","schema":{"type":"string"},"x-aliases":["username"]},{"name":"id","in":"query","required":false,"description":"Channel id (UC...).","schema":{"type":"string"},"x-aliases":["channelId","channel_id"]},{"name":"url","in":"query","required":false,"description":"Any channel URL (/@handle, /channel/UC..., /c/name).","schema":{"type":"string","format":"uri"},"x-hosts":["youtube.com","youtu.be"]},{"name":"query","in":"query","required":true,"description":"Keywords to search for inside the channel.","schema":{"type":"string"},"x-aliases":["keyword","q"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Annotated_Union_Post__Profile__Collection__Community___FieldInfo_annotation_NoneType__required_True__discriminator__object_____"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"youtube.channel.search","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"youtube","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"YouTube's own channel search: videos, Shorts, lives and playlists of one channel that match `query`. Keep the same channel and query while paging.","x-one-of":[["handle","id","url"]],"x-examples":[{"handle":"NASA","query":"artemis"}]}},"/v1/youtube/channel/playlists":{"get":{"operationId":"youtube.channel.playlists","summary":"YouTube channel playlists","tags":["youtube"],"parameters":[{"name":"handle","in":"query","required":false,"description":"Channel handle, with or without @.","schema":{"type":"string"},"x-aliases":["username"]},{"name":"id","in":"query","required":false,"description":"Channel id (UC...).","schema":{"type":"string"},"x-aliases":["channelId","channel_id"]},{"name":"url","in":"query","required":false,"description":"Any channel URL (/@handle, /channel/UC..., /c/name).","schema":{"type":"string","format":"uri"},"x-hosts":["youtube.com","youtu.be"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Collection__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"youtube.channel.playlists","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"youtube","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Playlists from a channel's Playlists tab: id, title, thumbnail, video count and URL.","x-one-of":[["handle","id","url"]],"x-examples":[{"handle":"NASA"}]}},"/v1/youtube/channel/shorts":{"get":{"operationId":"youtube.channel.shorts","summary":"YouTube channel Shorts","tags":["youtube"],"parameters":[{"name":"handle","in":"query","required":false,"description":"Channel handle, with or without @.","schema":{"type":"string"},"x-aliases":["username"]},{"name":"id","in":"query","required":false,"description":"Channel id (UC...).","schema":{"type":"string"},"x-aliases":["channelId","channel_id"]},{"name":"url","in":"query","required":false,"description":"Any channel URL (/@handle, /channel/UC..., /c/name).","schema":{"type":"string","format":"uri"},"x-hosts":["youtube.com","youtu.be"]},{"name":"sort","in":"query","required":false,"description":"Order of results. Changing it restarts the cursor chain.","schema":{"type":"string","enum":["latest","popular"],"default":"latest"},"x-aliases":["sort_by","sortBy","order"],"x-value-aliases":{"newest":"latest"}},{"name":"include_extras","in":"query","required":false,"description":"Also fetch length, publish date, likes and description per Short (slower, more errors).","schema":{"type":"boolean","default":false},"x-aliases":["includeExtras"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"youtube.channel.shorts","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"youtube","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"A channel's Shorts, newest first or most popular: id, title and view count. YouTube's Shorts tab shows no length or date; `include_extras` adds them with likes and the description.","x-one-of":[["handle","id","url"]],"x-examples":[{"handle":"MrBeast"}]}},"/v1/youtube/channel/lives":{"get":{"operationId":"youtube.channel.lives","summary":"YouTube channel live streams","tags":["youtube"],"parameters":[{"name":"handle","in":"query","required":false,"description":"Channel handle, with or without @.","schema":{"type":"string"},"x-aliases":["username"]},{"name":"id","in":"query","required":false,"description":"Channel id (UC...).","schema":{"type":"string"},"x-aliases":["channelId","channel_id"]},{"name":"url","in":"query","required":false,"description":"Any channel URL (/@handle, /channel/UC..., /c/name).","schema":{"type":"string","format":"uri"},"x-hosts":["youtube.com","youtu.be"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"youtube.channel.lives","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"youtube","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Live and past streams from a channel's Live tab. For a stream that is on air now, `stats.views` is the number watching, as YouTube's tab prints it.","x-one-of":[["handle","id","url"]],"x-examples":[{"handle":"NASA"}]}},"/v1/youtube/channel/community-posts":{"get":{"operationId":"youtube.channel.community_posts","summary":"YouTube channel community posts","tags":["youtube"],"parameters":[{"name":"handle","in":"query","required":false,"description":"Channel handle, with or without @.","schema":{"type":"string"},"x-aliases":["username"]},{"name":"id","in":"query","required":false,"description":"Channel id (UC...).","schema":{"type":"string"},"x-aliases":["channelId","channel_id"]},{"name":"url","in":"query","required":false,"description":"Any channel URL (/@handle, /channel/UC..., /c/name).","schema":{"type":"string","format":"uri"},"x-hosts":["youtube.com","youtu.be"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"youtube.channel.community_posts","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"youtube","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Posts from a channel's Posts tab: text, images, an attached video, likes and publish time.","x-one-of":[["handle","id","url"]],"x-examples":[{"handle":"MrBeast"}]}},"/v1/youtube/video":{"get":{"operationId":"youtube.video","summary":"YouTube video or Short details","tags":["youtube"],"parameters":[{"name":"url","in":"query","required":false,"description":"Video or Short URL (watch, youtu.be, shorts, live, embed).","schema":{"type":"string","format":"uri"},"x-hosts":["youtube.com","youtu.be"]},{"name":"id","in":"query","required":false,"description":"11-character video id.","schema":{"type":"string"},"x-aliases":["videoId","video_id"]},{"name":"language","in":"query","required":false,"description":"Preferred response language, 2 letters (en, es, fr). Not guaranteed: YouTube localises on its own.","schema":{"type":"string"},"x-aliases":["lang"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Post_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"youtube.video","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"youtube","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Title, description, stats, duration, channel, thumbnails, chapters, caption tracks and whether YouTube marks it as paid promotion (`is_sponsored`, null when YouTube's player could not be read for this request). Views, likes and the publish time are exact; the comment and subscriber counts are the abbreviated figures YouTube shows, with the display text in `extra`. Works for Shorts and lives.","x-one-of":[["url","id"]],"x-examples":[{"url":"https://www.youtube.com/watch?v=dQw4w9WgXcQ"}]}},"/v1/youtube/video/transcript":{"get":{"operationId":"youtube.video.transcript","summary":"YouTube video transcript","tags":["youtube"],"parameters":[{"name":"url","in":"query","required":false,"description":"Video or Short URL (watch, youtu.be, shorts, live, embed).","schema":{"type":"string","format":"uri"},"x-hosts":["youtube.com","youtu.be"]},{"name":"id","in":"query","required":false,"description":"11-character video id.","schema":{"type":"string"},"x-aliases":["videoId","video_id"]},{"name":"language","in":"query","required":false,"description":"Language code (\"en\", \"es\", \"en-US\"). Overrides the default track unless `original_audio` is set.","schema":{"type":"string"},"x-aliases":["lang"]},{"name":"original_audio","in":"query","required":false,"description":"Only return captions in the video's original spoken language. Takes precedence over `language`.","schema":{"type":"boolean","default":false}},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit for captions; AI transcription 1 up to 2 minutes, then 5 per started minute of the whole video.","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Transcript_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"youtube.video.transcript","x-credits":"transcript","x-credit-rule":"1 credit for captions; AI transcription 1 up to 2 minutes, then 5 per started minute of the whole video","x-status":"ga","x-pool":"youtube","x-mode":"sync","x-timeout-seconds":120,"x-cache":{"cacheable":true,"ttl_days":30},"description":"The video's own captions: the language you ask for (or the original audio's), typed by the uploader or recognised by YouTube (`source`), with the languages on offer. A video without captions answers transcript_unavailable and costs nothing; AI transcription of YouTube audio is not available yet.","x-one-of":[["url","id"]],"x-examples":[{"url":"https://www.youtube.com/watch?v=dQw4w9WgXcQ"}]}},"/v1/youtube/video/sponsors":{"get":{"operationId":"youtube.video.sponsors","summary":"YouTube video sponsors","tags":["youtube"],"parameters":[{"name":"url","in":"query","required":false,"description":"Video or Short URL (watch, youtu.be, shorts, live, embed).","schema":{"type":"string","format":"uri"},"x-hosts":["youtube.com","youtu.be"]},{"name":"id","in":"query","required":false,"description":"11-character video id.","schema":{"type":"string"},"x-aliases":["videoId","video_id"]},{"name":"language","in":"query","required":false,"description":"2-letter language used for the transcript lookup.","schema":{"type":"string"},"x-aliases":["lang"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Advertiser__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"youtube.video.sponsors","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"youtube","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Experimental. Whether the video discloses paid promotion, and the suspected sponsors with confidence and evidence in `extra`, inferred from the public description, its links, promo codes and the transcript. An inference, not a statement from YouTube; `parent` is the video.","x-one-of":[["url","id"]],"x-examples":[{"id":"JsBZOcqZerk"}]}},"/v1/youtube/search":{"get":{"operationId":"youtube.search","summary":"YouTube search","tags":["youtube"],"parameters":[{"name":"query","in":"query","required":true,"description":"Search terms.","schema":{"type":"string"},"x-aliases":["keyword","q"]},{"name":"type","in":"query","required":false,"description":"Kind of result.","schema":{"type":"string","enum":["video","channel","playlist","short","live"]},"x-aliases":["filter"],"x-value-aliases":{"videos":"video","shorts":"short","channels":"channel","playlists":"playlist"}},{"name":"upload_date","in":"query","required":false,"description":"Upload date filter.","schema":{"type":"string","enum":["hour","today","week","month","year"]},"x-aliases":["uploadDate"],"x-value-aliases":{"this_week":"week","this_month":"month","this_year":"year"}},{"name":"duration","in":"query","required":false,"description":"Video length (videos only, not Shorts).","schema":{"type":"string","enum":["short","medium","long"]},"x-value-aliases":{"under_3_min":"short","between_3_and_20_min":"medium","over_20_min":"long"}},{"name":"sort","in":"query","required":false,"description":"Order of results. YouTube now answers `latest` and `rating` in relevance order, so they are refused with invalid_params; use `relevance` or `popular` (view count) and narrow with `upload_date`.","schema":{"type":"string","enum":["relevance","latest","popular","rating"],"default":"relevance"},"x-aliases":["sort_by","sortBy","order"]},{"name":"include_extras","in":"query","required":false,"description":"Also fetch likes, comment count and description per video (slightly slower).","schema":{"type":"boolean","default":false},"x-aliases":["includeExtras"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"region","in":"query","required":false,"description":"Two-letter country code (ISO 3166-1) for results that vary by country.","schema":{"type":"string"},"example":"US","x-aliases":["country","geo"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Annotated_Union_Post__Profile__Collection__Community___FieldInfo_annotation_NoneType__required_True__discriminator__object_____"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"youtube.search","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"youtube","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Videos, channels, playlists, Shorts and live streams for a query. Shorts and live results are Posts of type `short` and `live`. For stricter title matching use YouTube's `intitle:` operator.","x-examples":[{"query":"lofi hip hop"}]}},"/v1/youtube/search/typeahead":{"get":{"operationId":"youtube.search.typeahead","summary":"YouTube search suggestions","tags":["youtube"],"parameters":[{"name":"query","in":"query","required":true,"description":"Partial or complete search text.","schema":{"type":"string"},"x-aliases":["keyword","q"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Suggestion__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"youtube.search.typeahead","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"youtube","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":1},"description":"The live suggestions YouTube shows while a user types. Channel suggestions carry the channel id, handle, name and thumbnail.","x-examples":[{"query":"mr beast"}]}},"/v1/youtube/search/hashtag":{"get":{"operationId":"youtube.search.hashtag","summary":"YouTube videos by hashtag","tags":["youtube"],"parameters":[{"name":"hashtag","in":"query","required":true,"description":"Hashtag, with or without #.","schema":{"type":"string"}},{"name":"type","in":"query","required":false,"description":"Kind of result.","schema":{"type":"string","enum":["all","short"]},"x-value-aliases":{"shorts":"short"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"youtube.search.hashtag","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"youtube","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Videos (or Shorts) on a hashtag's page. The `all` tab holds about 30 videos and usually no next page; the `short` tab pages with `cursor`.","x-examples":[{"hashtag":"minecraft"}]}},"/v1/youtube/video/comments":{"get":{"operationId":"youtube.video.comments","summary":"YouTube video comments","tags":["youtube"],"parameters":[{"name":"url","in":"query","required":false,"description":"Video or Short URL (watch, youtu.be, shorts, live, embed).","schema":{"type":"string","format":"uri"},"x-hosts":["youtube.com","youtu.be"]},{"name":"id","in":"query","required":false,"description":"11-character video id.","schema":{"type":"string"},"x-aliases":["videoId","video_id"]},{"name":"sort","in":"query","required":false,"description":"Order of results. Changing it restarts the cursor chain.","schema":{"type":"string","enum":["top","latest"],"default":"top"},"x-aliases":["sort_by","sortBy","order"],"x-value-aliases":{"newest":"latest"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Comment__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"youtube.video.comments","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"youtube","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Comments (about 1,000 top or 7,000 newest at most). Page with `cursor`.","x-one-of":[["url","id"]],"x-examples":[{"url":"https://www.youtube.com/watch?v=dQw4w9WgXcQ"}]}},"/v1/youtube/video/comment/replies":{"get":{"operationId":"youtube.video.comment.replies","summary":"YouTube comment replies","tags":["youtube"],"parameters":[{"name":"url","in":"query","required":false,"description":"Video or Short URL (watch, youtu.be, shorts, live, embed).","schema":{"type":"string","format":"uri"},"x-hosts":["youtube.com","youtu.be"]},{"name":"id","in":"query","required":false,"description":"11-character video id.","schema":{"type":"string"},"x-aliases":["videoId","video_id"]},{"name":"comment_id","in":"query","required":false,"description":"Id of the parent comment.","schema":{"type":"string"},"x-aliases":["commentId"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Comment__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"youtube.video.comment.replies","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"youtube","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Replies to one comment. Pass the comment's replies cursor from the comments list as `cursor` The cursor alone is enough (ScrapeCreators' `continuationToken`); the handler rejects a call with no cursor.","x-examples":[{"url":"https://www.youtube.com/watch?v=dQw4w9WgXcQ","comment_id":"UgzKYksqeQ5gA3t0g0F4AaABAg","cursor":"Eg0SC2RRdzR3OVdnWGNRGAYygwEaUBIaVWd3UHdUaWJ4ZGdxQ0haeGt0ZDRBYUFCQWciAggAKhhVQ3VBWEZrZ3N3MUw3eGFDZm5kNUpKT3cyC2RRdzR3OVdnWGNRQAFICoIBAggBQi9jb21tZW50LXJlcGxpZXMtaXRlbS1VZ3dQd1RpYnhkZ3FDSFp4a3RkNEFhQUJBZw%3D%3D"}]}},"/v1/youtube/shorts/trending":{"get":{"operationId":"youtube.shorts.trending","summary":"Trending YouTube Shorts","tags":["youtube"],"parameters":[{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"region","in":"query","required":false,"description":"Two-letter country code (ISO 3166-1) for results that vary by country.","schema":{"type":"string"},"example":"US","x-aliases":["country","geo"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"youtube.shorts.trending","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"youtube","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":1},"description":"YouTube has no trending page; this is the Shorts feed (about ten Shorts a page, different on each call, not a ranked chart), each with its title, channel, counts and date.","x-examples":[{}]}},"/v1/youtube/playlist":{"get":{"operationId":"youtube.playlist","summary":"YouTube playlist videos","tags":["youtube"],"parameters":[{"name":"url","in":"query","required":false,"description":"Playlist URL (list=...).","schema":{"type":"string","format":"uri"},"x-hosts":["youtube.com","youtu.be"]},{"name":"id","in":"query","required":false,"description":"Playlist id (PL..., UU..., OL...).","schema":{"type":"string"},"x-aliases":["playlist_id","playlistId"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"youtube.playlist","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"youtube","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"The playlist's videos; `parent` is the playlist itself.","x-one-of":[["url","id"]],"x-examples":[{"id":"PL2aBZuCeDwlTxZeGRlKrWpLiX_W7jpt6p"}]}},"/v1/youtube/community-post":{"get":{"operationId":"youtube.community_post","summary":"YouTube community post","tags":["youtube"],"parameters":[{"name":"url","in":"query","required":true,"description":"Community post URL (/post/Ug... or /channel/.../community?lb=...).","schema":{"type":"string","format":"uri"},"x-hosts":["youtube.com","youtu.be"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Post_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"youtube.community_post","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"youtube","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"x-examples":[{"url":"https://www.youtube.com/post/Ugkx-7xgRw-Uc9lRS3_2RvS2zASPTZOFtIlw"}]}},"/v1/tiktok/profile":{"get":{"operationId":"tiktok.profile","summary":"TikTok profile","tags":["tiktok"],"parameters":[{"name":"handle","in":"query","required":false,"description":"Username, with or without the leading @.","schema":{"type":"string"},"x-aliases":["username"]},{"name":"id","in":"query","required":false,"description":"TikTok user id (numeric) or secUid.","schema":{"type":"string"},"x-aliases":["user_id","secUid","sec_uid"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Profile_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"tiktok.profile","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"tiktok","x-mode":"sync","x-timeout-seconds":60.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Public profile of a TikTok account: name, bio, bio link, verification and exact counts. Pass `handle` or the numeric user id as `id` (a secUid cannot be looked up).","x-one-of":[["handle","id"]],"x-examples":[{"handle":"khaby.lame"}]}},"/v1/tiktok/profile/region":{"get":{"operationId":"tiktok.profile.region","summary":"TikTok profile region","tags":["tiktok"],"parameters":[{"name":"handle","in":"query","required":true,"description":"Username, with or without the leading @.","schema":{"type":"string"},"x-aliases":["username"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Profile_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"tiktok.profile.region","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"stub","x-pool":"tiktok","x-mode":"sync","x-timeout-seconds":60.0,"x-cache":{"cacheable":true,"ttl_days":1},"description":"NOT AVAILABLE: no TikTok surface we read carries an account's region (the web profile, the embed page and the Creative Center have none, and the app API that returns it, `user/profile/other`, refuses us), so this answers 501 not_implemented (free).","x-examples":[{"handle":"khaby.lame"}]}},"/v1/tiktok/profile/videos":{"get":{"operationId":"tiktok.profile.videos","summary":"TikTok profile videos","tags":["tiktok"],"parameters":[{"name":"handle","in":"query","required":false,"description":"Username, with or without the leading @.","schema":{"type":"string"},"x-aliases":["username"]},{"name":"id","in":"query","required":false,"description":"TikTok user id (numeric) or secUid.","schema":{"type":"string"},"x-aliases":["user_id","secUid","sec_uid"]},{"name":"sort","in":"query","required":false,"description":"Order of results. Changing it restarts the cursor chain.","schema":{"type":"string","enum":["latest","popular"],"default":"latest"},"x-aliases":["sort_by","sortBy","order"]},{"name":"include_pinned","in":"query","required":false,"description":"Set false to drop the pinned videos that can be told from the page order.","schema":{"type":"boolean","default":true}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"region","in":"query","required":false,"description":"Two-letter country code (ISO 3166-1) for results that vary by country.","schema":{"type":"string"},"example":"US","x-aliases":["country","geo"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"tiktok.profile.videos","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"tiktok","x-mode":"sync","x-timeout-seconds":60.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"The newest videos of a public account, from TikTok's embed page for it. One page of about 10 (pinned videos first, then newest first), and no cursor: `has_more` is false because more cannot be fetched, not because the account has no more. Each video has its id, caption, hashtags, cover, a signed play URL, size and play count (TikTok rounds it to two significant digits; `extra.views_rounded`), and a date taken from the video id (`extra.published_at_from_id`). Likes, comments, shares and duration are not on that page and stay null; `is_pinned` is true for a pinned video that can be told from the order (it never over-reports). `parent` is the account. `sort=popular` is refused, and a numeric `id` cannot be looked up: pass `handle`. A private account answers `private`, and an account whose creator limits its audience answers `age_restricted`.","x-one-of":[["handle","id"]],"x-examples":[{"handle":"khaby.lame"}],"x-aliases":["/v3/tiktok/profile/videos"]}},"/v1/tiktok/collection/videos":{"get":{"operationId":"tiktok.collection.videos","summary":"TikTok collection videos","tags":["tiktok"],"parameters":[{"name":"url","in":"query","required":true,"description":"Public collection URL (tiktok.com/@user/collection/<name>-<id>).","schema":{"type":"string","format":"uri"},"x-hosts":["tiktok.com"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"tiktok.collection.videos","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"tiktok","x-mode":"sync","x-timeout-seconds":60.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Videos saved in a public TikTok collection (also called a playlist).","x-examples":[{"url":"https://www.tiktok.com/@kibblemaster808/collection/Want-to-go-7665668414573546258"}]}},"/v1/tiktok/video":{"get":{"operationId":"tiktok.video","summary":"TikTok video details","tags":["tiktok"],"parameters":[{"name":"url","in":"query","required":false,"description":"Video URL (www.tiktok.com/@user/video/..., vm.tiktok.com/..., vt.tiktok.com/...).","schema":{"type":"string","format":"uri"},"x-hosts":["tiktok.com"]},{"name":"id","in":"query","required":false,"description":"Numeric video id.","schema":{"type":"string"},"x-aliases":["aweme_id","video_id"]},{"name":"get_transcript","in":"query","required":false,"description":"Include the video's native captions when it has them.","schema":{"type":"boolean","default":false}},{"name":"region","in":"query","required":false,"description":"Two-letter country code (ISO 3166-1) for results that vary by country.","schema":{"type":"string"},"example":"US","x-aliases":["country","geo"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Post_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"tiktok.video","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"tiktok","x-mode":"sync","x-timeout-seconds":60.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Metadata and engagement stats of one video or photo slideshow. `get_transcript=true` adds the native captions in `extra.transcript`; for AI transcription use `/v1/tiktok/video/transcript`.","x-one-of":[["url","id"]],"x-examples":[{"url":"https://www.tiktok.com/@khaby.lame/video/7137423965982592302"}],"x-aliases":["/v2/tiktok/video"]}},"/v1/tiktok/video/transcript":{"get":{"operationId":"tiktok.video.transcript","summary":"TikTok video transcript","tags":["tiktok"],"parameters":[{"name":"url","in":"query","required":false,"description":"Video URL (www.tiktok.com/@user/video/..., vm.tiktok.com/..., vt.tiktok.com/...).","schema":{"type":"string","format":"uri"},"x-hosts":["tiktok.com"]},{"name":"id","in":"query","required":false,"description":"Numeric video id.","schema":{"type":"string"},"x-aliases":["aweme_id","video_id"]},{"name":"language","in":"query","required":false,"description":"Preferred caption language (2-letter code: en, es, fr, de, it, ja, ko, zh).","schema":{"type":"string"},"x-aliases":["lang"]},{"name":"ai_fallback","in":"query","required":false,"description":"Transcribe the audio with AI when the video has no captions. Set false to get no transcript instead, and no AI charge.","schema":{"type":"boolean","default":true},"x-aliases":["use_ai_as_fallback"]},{"name":"allow_long_transcription","in":"query","required":false,"description":"Transcribe audio past 2 minutes with AI, at 5 credits per started minute of the whole video. Without it a longer video answers transcript_unavailable, which is free.","schema":{"type":"boolean","default":false},"x-aliases":["allowLongTranscription"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit for captions; AI transcription 1 up to 2 minutes, then 5 per started minute of the whole video.","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Transcript_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"tiktok.video.transcript","x-credits":"transcript","x-credit-rule":"1 credit for captions; AI transcription 1 up to 2 minutes, then 5 per started minute of the whole video","x-status":"ga","x-pool":"tiktok","x-mode":"sync","x-timeout-seconds":120,"x-cache":{"cacheable":true,"ttl_days":30},"description":"TikTok's own captions when the video has them (the English track first, else the first one); AI transcription of the audio when it does not. `language` steers the AI transcription only.","x-one-of":[["url","id"]],"x-examples":[{"url":"https://www.tiktok.com/@khaby.lame/video/7137423965982592302"}]}},"/v1/tiktok/video/comments":{"get":{"operationId":"tiktok.video.comments","summary":"TikTok video comments","tags":["tiktok"],"parameters":[{"name":"url","in":"query","required":false,"description":"Video URL (www.tiktok.com/@user/video/..., vm.tiktok.com/..., vt.tiktok.com/...).","schema":{"type":"string","format":"uri"},"x-hosts":["tiktok.com"]},{"name":"id","in":"query","required":false,"description":"Numeric video id.","schema":{"type":"string"},"x-aliases":["aweme_id","video_id"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Comment__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"tiktok.video.comments","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"tiktok","x-mode":"sync","x-timeout-seconds":60.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Comments on a video, with the commenter and like and reply counts.","x-one-of":[["url","id"]],"x-examples":[{"url":"https://www.tiktok.com/@khaby.lame/video/7137423965982592302"}]}},"/v1/tiktok/video/comment/replies":{"get":{"operationId":"tiktok.video.comment.replies","summary":"TikTok comment replies","tags":["tiktok"],"parameters":[{"name":"url","in":"query","required":false,"description":"Video URL (www.tiktok.com/@user/video/..., vm.tiktok.com/..., vt.tiktok.com/...).","schema":{"type":"string","format":"uri"},"x-hosts":["tiktok.com"]},{"name":"id","in":"query","required":false,"description":"Numeric video id.","schema":{"type":"string"},"x-aliases":["aweme_id","video_id"]},{"name":"comment_id","in":"query","required":true,"description":"TikTok comment id (the `cid` from the comments list).","schema":{"type":"string"},"x-aliases":["commentId","cid"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Comment__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"tiktok.video.comment.replies","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"tiktok","x-mode":"sync","x-timeout-seconds":60.0,"x-cache":{"cacheable":true,"ttl_days":30},"x-one-of":[["url","id"]],"x-examples":[{"url":"https://www.tiktok.com/@khaby.lame/video/7137423965982592302","comment_id":"7137510823549272878"}]}},"/v1/tiktok/profile/followers":{"get":{"operationId":"tiktok.profile.followers","summary":"TikTok followers","tags":["tiktok"],"parameters":[{"name":"handle","in":"query","required":false,"description":"Username, with or without the leading @.","schema":{"type":"string"},"x-aliases":["username"]},{"name":"id","in":"query","required":false,"description":"TikTok user id (numeric) or secUid.","schema":{"type":"string"},"x-aliases":["user_id","secUid","sec_uid"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Profile__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"tiktok.profile.followers","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"stub","x-pool":"tiktok","x-mode":"sync","x-timeout-seconds":60.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"NOT AVAILABLE: TikTok does not serve follower lists (the web API answers statusCode 10201; the app API's `user/follower/list` answers 403); answers 501 not_implemented (free).","x-one-of":[["handle","id"]],"x-examples":[{"handle":"khaby.lame"}],"x-aliases":["/v1/tiktok/user/followers"]}},"/v1/tiktok/profile/following":{"get":{"operationId":"tiktok.profile.following","summary":"TikTok following","tags":["tiktok"],"parameters":[{"name":"handle","in":"query","required":false,"description":"Username, with or without the leading @.","schema":{"type":"string"},"x-aliases":["username"]},{"name":"id","in":"query","required":false,"description":"TikTok user id (numeric) or secUid.","schema":{"type":"string"},"x-aliases":["user_id","secUid","sec_uid"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Profile__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"tiktok.profile.following","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"stub","x-pool":"tiktok","x-mode":"sync","x-timeout-seconds":60.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"NOT AVAILABLE: TikTok does not serve following lists (the web API answers statusCode 10201; the app API's `user/following/list` answers 403); answers 501 not_implemented (free).","x-one-of":[["handle","id"]],"x-examples":[{"handle":"khaby.lame"}],"x-aliases":["/v1/tiktok/user/following"]}},"/v1/tiktok/search/users":{"get":{"operationId":"tiktok.search.users","summary":"TikTok user search","tags":["tiktok"],"parameters":[{"name":"query","in":"query","required":true,"description":"Search terms.","schema":{"type":"string"},"x-aliases":["keyword","q"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Profile__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"tiktok.search.users","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"tiktok","x-mode":"sync","x-timeout-seconds":60.0,"x-cache":{"cacheable":true,"ttl_days":30},"x-examples":[{"query":"cooking"}]}},"/v1/tiktok/search/suggestions":{"get":{"operationId":"tiktok.search.suggestions","summary":"TikTok search suggestions","tags":["tiktok"],"parameters":[{"name":"query","in":"query","required":true,"description":"Partial or complete search text.","schema":{"type":"string"},"x-aliases":["keyword","q"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"region","in":"query","required":false,"description":"Two-letter country code (ISO 3166-1) for results that vary by country.","schema":{"type":"string"},"example":"US","x-aliases":["country","geo"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Suggestion__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"tiktok.search.suggestions","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"tiktok","x-mode":"sync","x-timeout-seconds":60.0,"x-cache":{"cacheable":true,"ttl_days":1},"description":"The autocomplete suggestions TikTok shows while someone types in search.","x-examples":[{"query":"dogs","region":"US"}]}},"/v1/tiktok/search/keyword":{"get":{"operationId":"tiktok.search.keyword","summary":"TikTok video search","tags":["tiktok"],"parameters":[{"name":"query","in":"query","required":true,"description":"Search terms.","schema":{"type":"string"},"x-aliases":["keyword","q"]},{"name":"sort","in":"query","required":false,"description":"Order of results. Changing it restarts the cursor chain.","schema":{"type":"string","enum":["relevance","likes","latest"],"default":"relevance"},"x-aliases":["sort_by","sortBy","order"],"x-value-aliases":{"most-liked":"likes","date-posted":"latest"}},{"name":"date_posted","in":"query","required":false,"description":"Posted within.","schema":{"type":"string","enum":["any","day","week","month","three_months","six_months"]},"x-aliases":["datePosted"],"x-value-aliases":{"yesterday":"day","this-week":"week","this-month":"month","last-3-months":"three_months","last-6-months":"six_months","all-time":"any"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"region","in":"query","required":false,"description":"Two-letter country code (ISO 3166-1) for results that vary by country.","schema":{"type":"string"},"example":"US","x-aliases":["country","geo"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"tiktok.search.keyword","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"tiktok","x-mode":"sync","x-timeout-seconds":60.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Video search across TikTok. TikTok ignores sort and date filters: `sort` other than `relevance` is refused, and `date_posted` drops videos older than the window from each page (pages can be short or empty; follow `has_more`). `region` is TikTok's region hint, not a proxy country. TikTok now asks for a login on keyword search: when it does, the list is the public videos under the hashtag of your query instead, which are not keyword matches, and `parent` is that hashtag with the explanation as its `description` and `extra.fallback` set to `hashtag`.","x-examples":[{"query":"air fryer recipes"}]}},"/v1/tiktok/search/hashtag":{"get":{"operationId":"tiktok.search.hashtag","summary":"TikTok videos by hashtag","tags":["tiktok"],"parameters":[{"name":"hashtag","in":"query","required":true,"description":"Hashtag, with or without #.","schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"region","in":"query","required":false,"description":"Two-letter country code (ISO 3166-1) for results that vary by country.","schema":{"type":"string"},"example":"US","x-aliases":["country","geo"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"tiktok.search.hashtag","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"tiktok","x-mode":"sync","x-timeout-seconds":60.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Videos under a hashtag, with the hashtag (its video and view counts) as `parent`. TikTok may return duplicates.","x-examples":[{"hashtag":"booktok"}]}},"/v1/tiktok/search/top":{"get":{"operationId":"tiktok.search.top","summary":"TikTok top search","tags":["tiktok"],"parameters":[{"name":"query","in":"query","required":true,"description":"Search terms.","schema":{"type":"string"},"x-aliases":["keyword","q"]},{"name":"publish_time","in":"query","required":false,"description":"Posted within.","schema":{"type":"string","enum":["any","day","week","month","three_months","six_months"]},"x-value-aliases":{"yesterday":"day","this-week":"week","this-month":"month","last-3-months":"three_months","last-6-months":"six_months","all-time":"any"}},{"name":"sort","in":"query","required":false,"description":"Order of results. Changing it restarts the cursor chain.","schema":{"type":"string","enum":["relevance","likes","latest"],"default":"relevance"},"x-aliases":["sort_by","sortBy","order"],"x-value-aliases":{"most-liked":"likes","date-posted":"latest"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"region","in":"query","required":false,"description":"Two-letter country code (ISO 3166-1) for results that vary by country.","schema":{"type":"string"},"example":"US","x-aliases":["country","geo"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Annotated_Union_Post__Profile__Collection__Community___FieldInfo_annotation_NoneType__required_True__discriminator__object_____"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"tiktok.search.top","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"tiktok","x-mode":"sync","x-timeout-seconds":60.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"TikTok's 'Top' tab: videos, photo carousels and a card of matching accounts (keyword search returns videos only). Same filter limits as keyword search: relevance order only; `publish_time` drops older items from each page. While TikTok asks for a login on search, the list is the public videos under the hashtag of your query (no accounts card), and `parent` is that hashtag with the explanation as its `description` and `extra.fallback` set to `hashtag`.","x-examples":[{"query":"nba"}]}},"/v1/tiktok/videos/popular":{"get":{"operationId":"tiktok.videos.popular","summary":"Popular TikTok videos","tags":["tiktok"],"parameters":[{"name":"period","in":"query","required":false,"description":"Accepted for compatibility; the Explore feed has no time window.","schema":{"type":"string","enum":["7","30"]}},{"name":"sort","in":"query","required":false,"description":"Accepted for compatibility; not applied.","schema":{"type":"string","enum":["views","likes","comments","shares"]},"x-aliases":["sort_by","sortBy","order"]},{"name":"category","in":"query","required":false,"description":"TikTok's numeric Explore category id (default 1).","schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"region","in":"query","required":false,"description":"Two-letter country code (ISO 3166-1) for results that vary by country.","schema":{"type":"string"},"example":"US","x-aliases":["country","geo"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"tiktok.videos.popular","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"tiktok","x-mode":"sync","x-timeout-seconds":60.0,"x-cache":{"cacheable":true,"ttl_days":1},"description":"Videos from TikTok's Explore feed, the nearest public list to 'popular' (the Creative Center ranking behind ScrapeCreators' endpoint needs a login). `period` and `sort` are accepted for compatibility and not applied; `category` picks an Explore category.","x-examples":[{"region":"US"}]}},"/v1/tiktok/creators/popular":{"get":{"operationId":"tiktok.creators.popular","summary":"Popular TikTok creators","tags":["tiktok"],"parameters":[{"name":"sort","in":"query","required":false,"description":"Order of results. Changing it restarts the cursor chain.","schema":{"type":"string","enum":["followers","engagement","avg_views"]},"x-aliases":["sort_by","sortBy","order"],"x-value-aliases":{"follower":"followers"}},{"name":"follower_count","in":"query","required":false,"description":"Follower range.","schema":{"type":"string","enum":["10K-100K","100K-1M","1M-10M","10M+"]},"x-aliases":["followerCount"]},{"name":"creator_country","in":"query","required":false,"description":"Two-letter country of the creator.","schema":{"type":"string","enum":["AU","BR","CA","EG","FR","DE","ID","IL","IT","JP","MY","PH","RU","SA","SG","KR","ES","TW","TH","TR","AE","GB","US","VN"]},"x-aliases":["creatorCountry"]},{"name":"audience_country","in":"query","required":false,"description":"Two-letter country of the audience.","schema":{"type":"string","enum":["AU","BR","CA","EG","FR","DE","ID","IL","IT","JP","MY","PH","RU","SA","SG","KR","ES","TW","TH","TR","AE","GB","US","VN"]},"x-aliases":["audienceCountry"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"region","in":"query","required":false,"description":"Two-letter country code (ISO 3166-1) for results that vary by country.","schema":{"type":"string"},"example":"US","x-aliases":["country","geo"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Profile__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"tiktok.creators.popular","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"stub","x-pool":"tiktok","x-mode":"sync","x-timeout-seconds":60.0,"x-cache":{"cacheable":true,"ttl_days":1},"description":"NOT AVAILABLE: the Creative Center's creator ranking answers `40101 no permission` and its 2026 redesign shows 'Coming soon' for creators; answers 501 not_implemented (free).","x-examples":[{"region":"US"}]}},"/v1/tiktok/songs/popular":{"get":{"operationId":"tiktok.songs.popular","summary":"Popular TikTok songs","tags":["tiktok"],"parameters":[{"name":"period","in":"query","required":false,"description":"Window in days.","schema":{"type":"string","enum":["7","30","120"]}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"region","in":"query","required":false,"description":"Two-letter country code (ISO 3166-1) for results that vary by country.","schema":{"type":"string"},"example":"US","x-aliases":["country","geo"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Song__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"tiktok.songs.popular","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"stub","x-pool":"tiktok","x-mode":"sync","x-timeout-seconds":60.0,"x-cache":{"cacheable":true,"ttl_days":1},"description":"NOT AVAILABLE: the Creative Center's sound ranking answers `40101 no permission` and its 2026 redesign dropped the trending-songs list; the app API's music lists refuse us; answers 501 not_implemented (free).","x-examples":[{"region":"US"}]}},"/v1/tiktok/song":{"get":{"operationId":"tiktok.song","summary":"TikTok song details","tags":["tiktok"],"parameters":[{"name":"id","in":"query","required":false,"description":"Sound (music) id.","schema":{"type":"string"},"x-aliases":["clipId","music_id"]},{"name":"url","in":"query","required":false,"description":"Sound URL (tiktok.com/music/...).","schema":{"type":"string","format":"uri"},"x-hosts":["tiktok.com"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Song_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"tiktok.song","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"tiktok","x-mode":"sync","x-timeout-seconds":60.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"A sound by its clip id (the number at the end of a tiktok.com/music/... URL).","x-one-of":[["id","url"]],"x-examples":[{"id":"7016547803243022337"}]}},"/v1/tiktok/song/videos":{"get":{"operationId":"tiktok.song.videos","summary":"TikTok videos using a song","tags":["tiktok"],"parameters":[{"name":"id","in":"query","required":false,"description":"Sound (music) id.","schema":{"type":"string"},"x-aliases":["clipId","music_id"]},{"name":"url","in":"query","required":false,"description":"Sound URL (tiktok.com/music/...).","schema":{"type":"string","format":"uri"},"x-hosts":["tiktok.com"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"tiktok.song.videos","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"tiktok","x-mode":"sync","x-timeout-seconds":60.0,"x-cache":{"cacheable":true,"ttl_days":30},"x-one-of":[["id","url"]],"x-examples":[{"id":"7016547803243022337"}]}},"/v1/tiktok/trending":{"get":{"operationId":"tiktok.trending","summary":"TikTok trending feed","tags":["tiktok"],"parameters":[{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"region","in":"query","required":false,"description":"Two-letter country code (ISO 3166-1) for results that vary by country.","schema":{"type":"string"},"example":"US","x-aliases":["country","geo"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"tiktok.trending","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"tiktok","x-mode":"sync","x-timeout-seconds":60.0,"x-cache":{"cacheable":true,"ttl_days":1},"description":"A For You feed: a handful of videos per call, different on every call (the feed is not stable, so pages can repeat).","x-examples":[{"region":"US"}],"x-aliases":["/v1/tiktok/get-trending-feed"]}},"/v1/tiktok/profile/live":{"get":{"operationId":"tiktok.profile.live","summary":"Is a TikTok user live","tags":["tiktok"],"parameters":[{"name":"handle","in":"query","required":true,"description":"Username, with or without the leading @.","schema":{"type":"string"},"x-aliases":["username"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_LiveStream_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"tiktok.profile.live","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"tiktok","x-mode":"sync","x-timeout-seconds":60.0,"x-cache":{"cacheable":false,"ttl_days":1},"description":"Whether the user is live now, with the room's details when they are.","x-examples":[{"handle":"khaby.lame"}],"x-aliases":["/v1/tiktok/user/live"]}},"/v1/tiktok/live":{"get":{"operationId":"tiktok.live","summary":"TikTok live room info","tags":["tiktok"],"parameters":[{"name":"url","in":"query","required":false,"description":"Live URL (tiktok.com/@user/live).","schema":{"type":"string","format":"uri"},"x-hosts":["tiktok.com"]},{"name":"id","in":"query","required":false,"description":"Live room id.","schema":{"type":"string"},"x-aliases":["room_id"]},{"name":"user_id","in":"query","required":false,"description":"Numeric TikTok user id of the live's owner (`id` from the profile); speeds the lookup.","schema":{"type":"string"}},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_LiveStream_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"tiktok.live","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"tiktok","x-mode":"sync","x-timeout-seconds":60.0,"x-cache":{"cacheable":false,"ttl_days":1},"description":"Room-level info for a live. Find the room id with `/v1/tiktok/profile/live`.","x-one-of":[["url","id"]],"x-examples":[{"url":"https://www.tiktok.com/@khaby.lame/live"}]}},"/v1/instagram/profile":{"get":{"operationId":"instagram.profile","summary":"Instagram profile","tags":["instagram"],"parameters":[{"name":"handle","in":"query","required":true,"description":"Username, with or without the leading @.","schema":{"type":"string"},"x-aliases":["username"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Profile_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"instagram.profile","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"instagram","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Biography, links, follower and following counts and account flags. `stats.posts` is null here (Instagram's profile query leaves it out): use `profile/post-count`. Private accounts answer the profile with `is_private` true.","x-examples":[{"handle":"nasa"}]}},"/v1/instagram/basic-profile":{"get":{"operationId":"instagram.basic_profile","summary":"Instagram profile by user id","tags":["instagram"],"parameters":[{"name":"id","in":"query","required":true,"description":"Numeric Instagram user id.","schema":{"type":"string"},"x-aliases":["userId","user_id"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Profile_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"instagram.basic_profile","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"instagram","x-mode":"sync","x-timeout-seconds":60,"x-cache":{"cacheable":true,"ttl_days":30},"description":"A profile summary by numeric user id: username, name, biography, links, picture, verification, follower and following counts, account privacy. `stats.posts` is null (use `profile/post-count`). Instagram has no direct lookup by id, so the account is found through its newest post: an id whose account has no visible posts (private, empty or unknown) answers not_found.","x-examples":[{"id":"528817151"}]}},"/v1/instagram/profile/post-count":{"get":{"operationId":"instagram.profile.post_count","summary":"Instagram profile post count","tags":["instagram"],"parameters":[{"name":"handle","in":"query","required":true,"description":"Username, with or without the leading @.","schema":{"type":"string"},"x-aliases":["username"]},{"name":"allow_estimated","in":"query","required":false,"description":"Return a scaled estimate when Instagram abbreviates the count (profiles over 10,000 posts). Without it such a profile answers an unbilled error.","schema":{"type":"boolean","default":false}},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Profile_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"instagram.profile.post_count","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"instagram","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"The profile with `stats.posts` filled in, for when `profile` returns it null. Read from the profile's embed page, which carries the exact count even above 10,000 posts (`extra.is_estimated` false); only if that page is unavailable does it fall back to the profile page, which abbreviates.","x-examples":[{"handle":"nasa"}]}},"/v1/instagram/profile/posts":{"get":{"operationId":"instagram.profile.posts","summary":"Instagram profile posts","tags":["instagram"],"parameters":[{"name":"handle","in":"query","required":false,"description":"Username, with or without the leading @.","schema":{"type":"string"},"x-aliases":["username"]},{"name":"id","in":"query","required":false,"description":"Numeric Instagram user id.","schema":{"type":"string"},"x-aliases":["user_id","userId"]},{"name":"require_play_counts","in":"query","required":false,"description":"Add likes, comments and video views to every row (one extra page per post), and fail rather than return a video post whose play count is missing (a real 0 is fine).","schema":{"type":"boolean","default":false}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"instagram.profile.posts","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"instagram","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"A paged feed of public posts: photos, videos, carousels and reels, 12 a page. Instagram's feed query carries no counts, so rows have captions, times and media URLs and every count in `stats` null; `require_play_counts=true` adds the likes, comments and (for videos) views of every post from its embed page, which is slower. Look a profile up by `handle`; a numeric `id` has no lookup.","x-one-of":[["handle","id"]],"x-examples":[{"handle":"nasa"}],"x-aliases":["/v2/instagram/user/posts"]}},"/v1/instagram/profile/reels":{"get":{"operationId":"instagram.profile.reels","summary":"Instagram profile reels","tags":["instagram"],"parameters":[{"name":"handle","in":"query","required":false,"description":"Username, with or without the leading @.","schema":{"type":"string"},"x-aliases":["username"]},{"name":"id","in":"query","required":false,"description":"Numeric Instagram user id.","schema":{"type":"string"},"x-aliases":["user_id","userId"]},{"name":"require_play_counts","in":"query","required":false,"description":"Fail rather than return a reel whose play count is missing.","schema":{"type":"boolean","default":false}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"instagram.profile.reels","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"instagram","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"A paged feed of the profile's public reels, 12 a page, with play, like and comment counts, caption, exact time, duration and video URL. `stats.views` is Instagram's play count (`extra.views_source` = plays). Look a profile up by `handle`.","x-one-of":[["handle","id"]],"x-examples":[{"handle":"nasa"}],"x-aliases":["/v1/instagram/user/reels"]}},"/v1/instagram/profile/tagged-posts":{"get":{"operationId":"instagram.profile.tagged_posts","summary":"Instagram tagged posts","tags":["instagram"],"parameters":[{"name":"handle","in":"query","required":false,"description":"Username, with or without the leading @.","schema":{"type":"string"},"x-aliases":["username"]},{"name":"id","in":"query","required":false,"description":"Numeric Instagram user id.","schema":{"type":"string"},"x-aliases":["user_id","userId"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"instagram.profile.tagged_posts","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"stub","x-pool":"instagram","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Public posts from the profile's Tagged tab, about 10 a page, until `has_more` is false. Not available: Instagram closes a profile's Tagged tab, along with its web route and GraphQL operation.","x-one-of":[["handle","id"]],"x-examples":[{"handle":"instagram"}],"x-aliases":["/v1/instagram/user/tagged-posts"]}},"/v1/instagram/post":{"get":{"operationId":"instagram.post","summary":"Instagram post or reel details","tags":["instagram"],"parameters":[{"name":"url","in":"query","required":false,"description":"Post or reel URL (/p/..., /reel/..., /tv/...).","schema":{"type":"string","format":"uri"},"x-hosts":["instagram.com","instagr.am"]},{"name":"id","in":"query","required":false,"description":"Shortcode or numeric media id.","schema":{"type":"string"},"x-aliases":["shortcode","media_id"]},{"name":"include_play_count","in":"query","required":false,"description":"Set false to skip the extra fetch for the video view count and answer faster.","schema":{"type":"boolean","default":true}},{"name":"region","in":"query","required":false,"description":"Two-letter country code (ISO 3166-1) for results that vary by country.","schema":{"type":"string"},"example":"US","x-aliases":["country","geo"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Post_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"instagram.post","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"instagram","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Caption, counts, media, owner, tagged users, co-authors, sound and carousel children of one post or reel. For videos `stats.views` is the view count of the post's embed page (`extra.views_source` = embed_views), which differs from the play count of the reels tab.","x-one-of":[["url","id"]],"x-examples":[{"url":"https://www.instagram.com/p/CxYQJO8xuC6/"}]}},"/v1/instagram/post/transcript":{"get":{"operationId":"instagram.post.transcript","summary":"Instagram reel transcript","tags":["instagram"],"parameters":[{"name":"url","in":"query","required":false,"description":"Post or reel URL (/p/..., /reel/..., /tv/...).","schema":{"type":"string","format":"uri"},"x-hosts":["instagram.com","instagr.am"]},{"name":"id","in":"query","required":false,"description":"Shortcode or numeric media id.","schema":{"type":"string"},"x-aliases":["shortcode","media_id"]},{"name":"allow_long_transcription","in":"query","required":false,"description":"Transcribe audio past 2 minutes with AI, at 5 credits per started minute of the whole video. Without it a longer video answers transcript_unavailable, which is free.","schema":{"type":"boolean","default":false},"x-aliases":["allowLongTranscription"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit for captions; AI transcription 1 up to 2 minutes, then 5 per started minute of the whole video.","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Transcript_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"instagram.post.transcript","x-credits":"transcript","x-credit-rule":"1 credit for captions; AI transcription 1 up to 2 minutes, then 5 per started minute of the whole video","x-status":"ga","x-pool":"instagram","x-mode":"sync","x-timeout-seconds":180,"x-cache":{"cacheable":true,"ttl_days":30},"description":"AI transcription of a reel or video post (Instagram has no public captions). The post's video file is read from its public embed page and transcribed on the shared speech boxes at the transcript price (1 credit up to 2 minutes, then 5 per started minute of the whole video). Photos and carousels without a video answer transcript_unavailable, which is free.","x-one-of":[["url","id"]],"x-examples":[{"url":"https://www.instagram.com/reel/C8rKmYvsrck/"}],"x-aliases":["/v2/instagram/media/transcript"]}},"/v1/instagram/post/comments":{"get":{"operationId":"instagram.post.comments","summary":"Instagram post comments","tags":["instagram"],"parameters":[{"name":"url","in":"query","required":false,"description":"Post or reel URL (/p/..., /reel/..., /tv/...).","schema":{"type":"string","format":"uri"},"x-hosts":["instagram.com","instagr.am"]},{"name":"id","in":"query","required":false,"description":"Shortcode or numeric media id.","schema":{"type":"string"},"x-aliases":["shortcode","media_id"]},{"name":"include_replies","in":"query","required":false,"description":"Accepted for compatibility; replies are not available, so it changes nothing.","schema":{"type":"boolean","default":false}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Comment__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"instagram.post.comments","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"instagram","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"The first page of a post's comments (about 14, in Instagram's own order), with each comment's likes; reply counts are null (Instagram sends them empty). Instagram offers no way to the next page, so `has_more` is always false and the total is in the post's `stats.comments`. `include_replies` is accepted and ignored: replies are not available.","x-one-of":[["url","id"]],"x-examples":[{"url":"https://www.instagram.com/reel/DfF3eqGSKKc/"}],"x-aliases":["/v2/instagram/post/comments"]}},"/v1/instagram/post/comment/replies":{"get":{"operationId":"instagram.post.comment.replies","summary":"Instagram comment replies","tags":["instagram"],"parameters":[{"name":"url","in":"query","required":false,"description":"Post or reel URL (/p/..., /reel/..., /tv/...).","schema":{"type":"string","format":"uri"},"x-hosts":["instagram.com","instagr.am"]},{"name":"id","in":"query","required":false,"description":"Shortcode or numeric media id.","schema":{"type":"string"},"x-aliases":["shortcode","media_id"]},{"name":"comment_id","in":"query","required":true,"description":"Id of the parent comment (the `id` from the comments list).","schema":{"type":"string"},"x-aliases":["commentId"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Comment__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"instagram.post.comment.replies","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"stub","x-pool":"instagram","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Public replies to one comment: text, time, likes and `parent_id`. Not available: Instagram shows no replies (comment reply counts come back empty and a comment's own page redirects away), and its reply routes are closed.","x-one-of":[["url","id"]],"x-examples":[{"url":"https://www.instagram.com/p/CxYQJO8xuC6/","comment_id":"replace-me"}]}},"/v1/instagram/search":{"get":{"operationId":"instagram.search","summary":"Instagram search","tags":["instagram"],"parameters":[{"name":"query","in":"query","required":true,"description":"Username, hashtag, place or keyword.","schema":{"type":"string"},"x-aliases":["keyword","q"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Suggestion__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"instagram.search","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"stub","x-pool":"instagram","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":1},"description":"Instagram's own ranked users, hashtags, places and keyword suggestions for a query (one page, no posts). Not available: Instagram's search (every route and GraphQL operation behind its search box) is closed. For posts use `search/popular`; for hashtag posts `search/hashtag`.","x-examples":[{"query":"nike"}]}},"/v1/instagram/search/popular":{"get":{"operationId":"instagram.search.popular","summary":"Instagram popular topic","tags":["instagram"],"parameters":[{"name":"query","in":"query","required":true,"description":"The Popular topic to look up.","schema":{"type":"string"},"x-aliases":["keyword","q"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"instagram.search.popular","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"instagram","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Explore a topic through Instagram's public Popular search: the reels it curates for a keyword, about 50 to 70 over 5 or 6 pages (health and finance terms are thin; some single words have none). Rows carry the caption, author, time and duration; Instagram sends no counts here, so every count in `stats` is null. No `parent`. Pass the cursor back with the same query.","x-examples":[{"query":"basketball"}]}},"/v1/instagram/search/hashtag":{"get":{"operationId":"instagram.search.hashtag","summary":"Instagram posts by hashtag","tags":["instagram"],"parameters":[{"name":"hashtag","in":"query","required":true,"description":"The hashtag, with or without #.","schema":{"type":"string"}},{"name":"date_posted","in":"query","required":false,"description":"Only posts found in this window.","schema":{"type":"string","enum":["day","week","month","year"]},"x-value-aliases":{"last-hour":"hour","last-day":"day","last-week":"week","last-month":"month","last-year":"year"}},{"name":"media_type","in":"query","required":false,"description":"Posts and reels, or reels only.","schema":{"type":"string","enum":["all","reels"]}},{"name":"enrich","in":"query","required":false,"description":"Read each post for its full caption, author, media and counts (on by default). Off returns only what the search result states, much cheaper and faster.","schema":{"type":"boolean","default":true}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"instagram.search.hashtag","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"instagram","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Public posts and reels for an exact hashtag that a web search has indexed (DuckDuckGo's results, not Google's), best effort and not a complete hashtag feed. The cursor is the next results page and cannot go past 11. Each result is read through the Instagram post endpoint for caption, author, media and counts (`enrich`, on by default; a post that no longer exists is dropped). `date_posted` takes day, week, month or year. When the search provider asks for human verification on every try the call fails and can be retried.","x-examples":[{"hashtag":"makeup"}]}},"/v1/instagram/search/profiles":{"get":{"operationId":"instagram.search.profiles","summary":"Instagram profile search","tags":["instagram"],"parameters":[{"name":"query","in":"query","required":true,"description":"Profile name or username.","schema":{"type":"string"},"x-aliases":["keyword","q"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Profile__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"instagram.search.profiles","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"stub","x-pool":"instagram","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Instagram-native profile lookup. The first 10 accounts are enriched (bio, links, counts); the rest keep id, username, name, verification and picture only. Not available: Instagram's profile search is closed. Look an exact username up with `profile`.","x-examples":[{"query":"fitness coach"}]}},"/v1/instagram/search/reels":{"get":{"operationId":"instagram.search.reels","summary":"Instagram reel search","tags":["instagram"],"parameters":[{"name":"query","in":"query","required":true,"description":"Search terms.","schema":{"type":"string"},"x-aliases":["keyword","q"]},{"name":"date_posted","in":"query","required":false,"description":"Accepted for compatibility; not applied (no date filter upstream).","schema":{"type":"string","enum":["week","month","year"]},"x-value-aliases":{"last-week":"week","last-month":"month","last-year":"year"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"instagram.search.reels","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"instagram","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Reels for a keyword or phrase from Instagram's public Popular search (the same source as `search/popular`; it is not search-indexed), about 50 to 70 over 5 or 6 pages. `date_posted` is accepted for compatibility and not applied: Popular search has no date filter.","x-examples":[{"query":"sourdough"}],"x-aliases":["/v2/instagram/reels/search"]}},"/v1/instagram/reels/trending":{"get":{"operationId":"instagram.reels.trending","summary":"Instagram trending reels","tags":["instagram"],"parameters":[{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"instagram.reels.trending","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"instagram","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":1},"description":"Reels from Instagram's Reels feed, 8 a page, with like and comment counts (the feed carries no play counts), caption, author and video URL. The feed is whatever Instagram serves from the engine's region, so it changes from call to call.","x-examples":[{}]}},"/v1/instagram/profile/highlights":{"get":{"operationId":"instagram.profile.highlights","summary":"Instagram story highlights","tags":["instagram"],"parameters":[{"name":"handle","in":"query","required":false,"description":"Username, with or without the leading @.","schema":{"type":"string"},"x-aliases":["username"]},{"name":"id","in":"query","required":false,"description":"Numeric Instagram user id.","schema":{"type":"string"},"x-aliases":["user_id","userId"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Collection__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"instagram.profile.highlights","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"instagram","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"The profile's highlight albums: id, title, cover and owner. Look a profile up by `handle`; a numeric `id` has no lookup.","x-one-of":[["handle","id"]],"x-examples":[{"handle":"nasa"}],"x-aliases":["/v1/instagram/user/highlights"]}},"/v1/instagram/highlight":{"get":{"operationId":"instagram.highlight","summary":"Instagram highlight stories","tags":["instagram"],"parameters":[{"name":"id","in":"query","required":true,"description":"Highlight id (from profile/highlights) or a /stories/highlights/ URL.","schema":{"type":"string"},"x-aliases":["highlight_id"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"instagram.highlight","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"instagram","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"The stories in one highlight; `parent` is the highlight.","x-examples":[{"id":"18195781759377100"}],"x-aliases":["/v1/instagram/user/highlight/detail"]}},"/v1/instagram/song/reels":{"get":{"operationId":"instagram.song.reels","summary":"Instagram reels using a song","tags":["instagram"],"parameters":[{"name":"id","in":"query","required":true,"description":"Audio id from the audio page URL (instagram.com/reels/audio/<id>/).","schema":{"type":"string"},"x-aliases":["audio_id","audioId"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"instagram.song.reels","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"instagram","x-mode":"sync","x-timeout-seconds":60,"x-cache":{"cacheable":true,"ttl_days":30},"description":"The reels that use one sound, from the data behind instagram.com/reels/audio/<id>/: 12 a page with play, like and comment counts, caption, author, time, duration and video URL; `parent` is the sound (a licensed track or a creator's original audio, with how many reels use it in `stats.uses`). Works for the id in the audio page's URL.","x-examples":[{"id":"1392969992841787"}],"x-aliases":["/v1/instagram/audio/reels"]}},"/v1/instagram/profile/embed":{"get":{"operationId":"instagram.profile.embed","summary":"Instagram profile embed HTML","tags":["instagram"],"parameters":[{"name":"handle","in":"query","required":true,"description":"Username, with or without the leading @.","schema":{"type":"string"},"x-aliases":["username"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Embed_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"instagram.profile.embed","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"instagram","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"The profile's embed document (what Instagram serves at /<handle>/embed/): HTML in `html`, with the follower and post counts it carries in `extra`.","x-examples":[{"handle":"nasa"}],"x-aliases":["/v1/instagram/user/embed"]}},"/v1/reddit/subreddit/details":{"get":{"operationId":"reddit.subreddit.details","summary":"Subreddit details","tags":["reddit"],"parameters":[{"name":"subreddit","in":"query","required":false,"description":"Subreddit name without r/.","schema":{"type":"string"},"x-aliases":["sub"]},{"name":"url","in":"query","required":false,"description":"Subreddit URL (reddit.com/r/<name>).","schema":{"type":"string","format":"uri"},"x-hosts":["reddit.com","redd.it"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Community_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"reddit.subreddit.details","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"reddit","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Name, description, icon, banner, and weekly visitors and contributions in `extra`. Reddit does not show the subscriber count, so `member_count` is empty.","x-one-of":[["subreddit","url"]],"x-examples":[{"subreddit":"python"}]}},"/v1/reddit/subreddit/posts":{"get":{"operationId":"reddit.subreddit.posts","summary":"Subreddit posts","tags":["reddit"],"parameters":[{"name":"subreddit","in":"query","required":true,"description":"Subreddit name without r/.","schema":{"type":"string"},"x-aliases":["sub"]},{"name":"sort","in":"query","required":false,"description":"Order of results. Changing it restarts the cursor chain.","schema":{"type":"string","enum":["hot","new","top","rising","controversial","best"],"default":"hot"},"x-aliases":["sort_by","sortBy","order"]},{"name":"timeframe","in":"query","required":false,"description":"Window for top/controversial sorts.","schema":{"type":"string","enum":["hour","day","week","month","year","all"]},"x-aliases":["t","time"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"reddit.subreddit.posts","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"reddit","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Posts in a subreddit; `parent` is the subreddit. The cursor is Reddit's `after` token.","x-examples":[{"subreddit":"python"}],"x-aliases":["/v1/reddit/subreddit"]}},"/v1/reddit/subreddit/search":{"get":{"operationId":"reddit.subreddit.search","summary":"Search within a subreddit","tags":["reddit"],"parameters":[{"name":"subreddit","in":"query","required":true,"description":"Subreddit name without r/.","schema":{"type":"string"},"x-aliases":["sub"]},{"name":"query","in":"query","required":true,"description":"Search terms.","schema":{"type":"string"},"x-aliases":["keyword","q"]},{"name":"timeframe","in":"query","required":false,"description":"Only posts from this window.","schema":{"type":"string","enum":["day","week","month","year"]},"x-aliases":["t","time"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"reddit.subreddit.search","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"reddit","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Posts in one subreddit, found through DuckDuckGo's index and in DuckDuckGo's order, each filled in from Reddit with its score and counts. Reddit's own search and comment search are not available.","x-examples":[{"subreddit":"python","query":"asyncio"}]}},"/v1/reddit/post":{"get":{"operationId":"reddit.post","summary":"Reddit post","tags":["reddit"],"parameters":[{"name":"url","in":"query","required":true,"description":"Post URL (reddit.com/r/.../comments/..., redd.it/..., mobile share links).","schema":{"type":"string","format":"uri"},"x-hosts":["reddit.com","redd.it"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Post_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"reddit.post","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"reddit","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"One post without its comments: title, body text, author, subreddit, score, upvote ratio, counts and flags. Accepts canonical URLs and mobile share URLs.","x-examples":[{"url":"https://www.reddit.com/r/webscraping/comments/1q6pxwn/just_started_web_scraping_is_this_a_good_start/"}]}},"/v1/reddit/post/comments":{"get":{"operationId":"reddit.post.comments","summary":"Reddit post comments","tags":["reddit"],"parameters":[{"name":"url","in":"query","required":true,"description":"Post URL (reddit.com/r/.../comments/..., redd.it/..., mobile share links).","schema":{"type":"string","format":"uri"},"x-hosts":["reddit.com","redd.it"]},{"name":"sort","in":"query","required":false,"description":"Order of results. Changing it restarts the cursor chain.","schema":{"type":"string","enum":["confidence","top","new","controversial","old","qa"],"default":"confidence"},"x-aliases":["sort_by","sortBy","order"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Comment__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"reddit.post.comments","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"reddit","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"The post's comment tree, flattened in display order (replies carry parent_id); on the first page `parent` is the post. Replies Reddit folds away stay folded.","x-examples":[{"url":"https://www.reddit.com/r/webscraping/comments/1q6pxwn/just_started_web_scraping_is_this_a_good_start/"}]},"post":{"operationId":"reddit.post.comments.post","summary":"Reddit post comments (POST body)","tags":["reddit"],"parameters":[{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]},{"name":"Idempotency-Key","in":"header","required":false,"description":"Send the same value when retrying: the first answer is returned and nothing is charged twice. Kept 24 hours.","schema":{"type":"string","maxLength":255}}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Comment__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"reddit.post.comments.post","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"reddit","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"The same as the GET form, with the parameters in a JSON body. Use it when the cursor has grown too long for a URL. Pass one cursor exactly as returned.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri","description":"Post URL."},"sort":{"type":"string","enum":["confidence","top","new","controversial","old","qa"],"default":"confidence","description":"Order of results. Changing it restarts the cursor chain."}}}}}},"x-examples":[{"url":"https://www.reddit.com/r/webscraping/comments/1q6pxwn/just_started_web_scraping_is_this_a_good_start/"}]}},"/v1/reddit/post/transcript":{"get":{"operationId":"reddit.post.transcript","summary":"Reddit video post transcript","tags":["reddit"],"parameters":[{"name":"url","in":"query","required":true,"description":"Post URL or a direct v.redd.it video URL.","schema":{"type":"string","format":"uri"},"x-hosts":["reddit.com","redd.it"]},{"name":"allow_long_transcription","in":"query","required":false,"description":"Transcribe audio past 2 minutes with AI, at 5 credits per started minute of the whole video. Without it a longer video answers transcript_unavailable, which is free.","schema":{"type":"boolean","default":false},"x-aliases":["allowLongTranscription"]},{"name":"language","in":"query","required":false,"description":"2-letter language. Captions in another language are skipped for AI transcription in this one; by default whatever Reddit has.","schema":{"type":"string"},"x-aliases":["lang"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit for captions; AI transcription 1 up to 2 minutes, then 5 per started minute of the whole video.","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Transcript_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"reddit.post.transcript","x-credits":"transcript","x-credit-rule":"1 credit for captions; AI transcription 1 up to 2 minutes, then 5 per started minute of the whole video","x-status":"ga","x-pool":"reddit","x-mode":"sync","x-timeout-seconds":120,"x-cache":{"cacheable":true,"ttl_days":30},"description":"The transcript of a Reddit video post or v.redd.it link: Reddit's own automatic captions when it has them, otherwise AI transcription of the audio.","x-examples":[{"url":"https://www.reddit.com/r/interestingasfuck/comments/1xl30t2/a_bird_watches_a_man_fish_he_offers_it_his_catch/"}]}},"/v1/reddit/search":{"get":{"operationId":"reddit.search","summary":"Reddit search","tags":["reddit"],"parameters":[{"name":"query","in":"query","required":true,"description":"Search terms.","schema":{"type":"string"},"x-aliases":["keyword","q"]},{"name":"timeframe","in":"query","required":false,"description":"Only posts from this window.","schema":{"type":"string","enum":["day","week","month","year"]},"x-aliases":["t","time"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"reddit.search","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"reddit","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Posts across Reddit, found through DuckDuckGo's index and in DuckDuckGo's order, each filled in from Reddit with its score and counts. Reddit's own search and comment search are not available.","x-examples":[{"query":"mechanical keyboard"}]}},"/v1/bluesky/profile":{"get":{"operationId":"bluesky.profile","summary":"Bluesky profile","tags":["bluesky"],"parameters":[{"name":"handle","in":"query","required":true,"description":"Handle (alice.bsky.social) or DID (did:plc:...).","schema":{"type":"string"},"x-aliases":["username"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Profile_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"bluesky.profile","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"x-examples":[{"handle":"bsky.app"}]}},"/v1/bluesky/profile/posts":{"get":{"operationId":"bluesky.profile.posts","summary":"Bluesky profile posts","tags":["bluesky"],"parameters":[{"name":"handle","in":"query","required":true,"description":"Handle (alice.bsky.social) or DID (did:plc:...).","schema":{"type":"string"},"x-aliases":["username","user_id"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"bluesky.profile.posts","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"A paged feed of the user's posts. Pass the DID (ScrapeCreators' `user_id`) for faster lookups.","x-examples":[{"handle":"bsky.app"}],"x-aliases":["/v1/bluesky/user/posts"]}},"/v1/bluesky/post":{"get":{"operationId":"bluesky.post","summary":"Bluesky post","tags":["bluesky"],"parameters":[{"name":"url","in":"query","required":true,"description":"Post URL (bsky.app/profile/<handle>/post/<rkey>).","schema":{"type":"string","format":"uri"},"x-hosts":["bsky.app"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Post_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"bluesky.post","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"The post with its embed content and counts, and its threaded replies in `extra.replies`.","x-examples":[{"url":"https://bsky.app/profile/espn.com/post/3lqdfq7fkvm2g"}]}},"/v1/threads/profile":{"get":{"operationId":"threads.profile","summary":"Threads profile","tags":["threads"],"parameters":[{"name":"handle","in":"query","required":true,"description":"Username, with or without the leading @.","schema":{"type":"string"},"x-aliases":["username"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Profile_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"threads.profile","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"x-examples":[{"handle":"zuck"}]}},"/v1/threads/profile/posts":{"get":{"operationId":"threads.profile.posts","summary":"Threads profile posts","tags":["threads"],"parameters":[{"name":"handle","in":"query","required":true,"description":"Username, with or without the leading @.","schema":{"type":"string"},"x-aliases":["username"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"threads.profile.posts","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"The most recent posts, newest first, about 15 per page. Threads shows only the latest 20 to 30 posts of a profile, so paging runs out early.","x-examples":[{"handle":"zuck"}],"x-aliases":["/v1/threads/user/posts"]}},"/v1/threads/post":{"get":{"operationId":"threads.post","summary":"Threads post","tags":["threads"],"parameters":[{"name":"url","in":"query","required":true,"description":"Post URL (threads.net/@user/post/...).","schema":{"type":"string","format":"uri"},"x-hosts":["threads.net","threads.com"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Post_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"threads.post","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"The post with its counts and media, and its top replies in `extra.replies`.","x-examples":[{"url":"https://www.threads.com/@zuck/post/DeZtp-TkQHh"}]}},"/v1/threads/search":{"get":{"operationId":"threads.search","summary":"Threads post search","tags":["threads"],"parameters":[{"name":"query","in":"query","required":true,"description":"Search terms.","schema":{"type":"string"},"x-aliases":["keyword","q"]},{"name":"start_date","in":"query","required":false,"description":"Only posts from this date (YYYY-MM-DD).","schema":{"type":"string"},"x-aliases":["startDate"]},{"name":"end_date","in":"query","required":false,"description":"Only posts up to this date (YYYY-MM-DD).","schema":{"type":"string"},"x-aliases":["endDate"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"threads.search","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Posts matching a keyword: one page of about 15 to 20 results, no paging. `start_date` and `end_date` filter the page by post date (Threads does not apply them itself).","x-examples":[{"query":"basketball"}]}},"/v1/threads/search/users":{"get":{"operationId":"threads.search.users","summary":"Threads user search","tags":["threads"],"parameters":[{"name":"query","in":"query","required":true,"description":"Search terms.","schema":{"type":"string"},"x-aliases":["keyword","q"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Profile__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"threads.search.users","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Accounts matching a query. There is no direct account search, so these are the authors of the search results whose handle or name matches, best match first, plus the account whose handle is the query itself.","x-examples":[{"query":"nasa"}]}},"/v1/truthsocial/profile":{"get":{"operationId":"truthsocial.profile","summary":"Truth Social profile","tags":["truthsocial"],"parameters":[{"name":"handle","in":"query","required":true,"description":"Username, with or without the leading @.","schema":{"type":"string"},"x-aliases":["username"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Profile_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"truthsocial.profile","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Public profile of a Truth Social account. Accounts that do not exist answer not_found.","x-examples":[{"handle":"realDonaldTrump"}]}},"/v1/truthsocial/profile/posts":{"get":{"operationId":"truthsocial.profile.posts","summary":"Truth Social profile posts","tags":["truthsocial"],"parameters":[{"name":"handle","in":"query","required":false,"description":"Username, with or without the leading @.","schema":{"type":"string"},"x-aliases":["username"]},{"name":"id","in":"query","required":false,"description":"Truth Social user id (the `id` from the profile).","schema":{"type":"string"},"x-aliases":["user_id"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"truthsocial.profile.posts","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"A paged list of the account's own posts (ReTruths are left out), newest first. A numeric `id` (the profile's id) saves a lookup call.","x-one-of":[["handle","id"]],"x-examples":[{"handle":"realDonaldTrump"}],"x-aliases":["/v1/truthsocial/user/posts"]}},"/v1/truthsocial/post":{"get":{"operationId":"truthsocial.post","summary":"Truth Social post","tags":["truthsocial"],"parameters":[{"name":"url","in":"query","required":true,"description":"Post URL (truthsocial.com/@user/<id>).","schema":{"type":"string","format":"uri"},"x-hosts":["truthsocial.com"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Post_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"truthsocial.post","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"x-examples":[{"url":"https://truthsocial.com/@realDonaldTrump/117526232618166329"}]}},"/v1/pinterest/search":{"get":{"operationId":"pinterest.search","summary":"Pinterest pin search","tags":["pinterest"],"parameters":[{"name":"query","in":"query","required":true,"description":"Search terms.","schema":{"type":"string"},"x-aliases":["keyword","q"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"pinterest.search","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Pins matching a keyword, about 24 per page. Search pins carry opaque ids (e1_...), so their `url` is the pin page but the pin endpoint cannot look the id up again.","x-examples":[{"query":"living room ideas"}]}},"/v1/pinterest/pin":{"get":{"operationId":"pinterest.pin","summary":"Pinterest pin","tags":["pinterest"],"parameters":[{"name":"url","in":"query","required":true,"description":"Pin URL (pinterest.com/pin/..., pin.it/...).","schema":{"type":"string","format":"uri"},"x-hosts":["pinterest.com","pin.it","pinterest.co.uk","pinterest.ca","pinterest.com.au","pinterest.de","pinterest.fr"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Post_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"pinterest.pin","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"One pin: title, description, outbound link, board, pinner, saves, reactions and image or video. Needs the numeric pin id in the URL; pin.it short links are followed.","x-examples":[{"url":"https://www.pinterest.com/pin/36662184461578355/"}]}},"/v1/pinterest/profile/boards":{"get":{"operationId":"pinterest.profile.boards","summary":"Pinterest user boards","tags":["pinterest"],"parameters":[{"name":"handle","in":"query","required":true,"description":"Username, with or without the leading @.","schema":{"type":"string"},"x-aliases":["username"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Collection__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"pinterest.profile.boards","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"x-examples":[{"handle":"pinterest"}],"x-aliases":["/v1/pinterest/user/boards"]}},"/v1/pinterest/board":{"get":{"operationId":"pinterest.board","summary":"Pinterest board pins","tags":["pinterest"],"parameters":[{"name":"url","in":"query","required":true,"description":"Board URL (pinterest.com/<user>/<board>/).","schema":{"type":"string","format":"uri"},"x-hosts":["pinterest.com","pin.it","pinterest.co.uk","pinterest.ca","pinterest.com.au","pinterest.de","pinterest.fr"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"pinterest.board","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"The board's pins, 25 per page; `parent` is the board. Pinterest hands out a bookmark for the next page on some boards and none on others (a 183-pin board stops after its first 25), so follow `cursor` while `has_more` is true and expect large boards to come back partial.","x-examples":[{"url":"https://www.pinterest.com/pinterest/holiday-decor-ideas/"}]}},"/v1/pinterest/topic":{"get":{"operationId":"pinterest.topic","summary":"Pinterest topic pins","tags":["pinterest"],"parameters":[{"name":"url","in":"query","required":true,"description":"Topic URL (pinterest.com/ideas/<topic>/<id>/).","schema":{"type":"string","format":"uri"},"x-hosts":["pinterest.com","pin.it","pinterest.co.uk","pinterest.ca","pinterest.com.au","pinterest.de","pinterest.fr"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"pinterest.topic","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Pins for an ideas topic. `parent` is the topic with its `search_count` and related `refinements` (first page only: they come from the ideas page).","x-examples":[{"url":"https://www.pinterest.com/ideas/how-to-stop-leash-pulling/894604313079/"}]}},"/v1/twitch/profile":{"get":{"operationId":"twitch.profile","summary":"Twitch channel","tags":["twitch"],"parameters":[{"name":"handle","in":"query","required":true,"description":"Username, with or without the leading @.","schema":{"type":"string"},"x-aliases":["username"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Profile_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"twitch.profile","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"x-examples":[{"handle":"shroud"}]}},"/v1/twitch/user/videos":{"get":{"operationId":"twitch.user.videos","summary":"Twitch user videos","tags":["twitch"],"parameters":[{"name":"handle","in":"query","required":true,"description":"Username, with or without the leading @.","schema":{"type":"string"},"x-aliases":["username"]},{"name":"type","in":"query","required":false,"description":"Kind of video.","schema":{"type":"string","enum":["highlight","archive","upload"]},"x-aliases":["filter_by","filter"],"x-value-aliases":{"HIGHLIGHT":"highlight","ARCHIVE":"archive","UPLOAD":"upload"}},{"name":"sort","in":"query","required":false,"description":"Order of results. Changing it restarts the cursor chain.","schema":{"type":"string","enum":["time","views"]},"x-aliases":["sort_by","sortBy","order"],"x-value-aliases":{"TIME":"time","VIEWS":"views"}},{"name":"limit","in":"query","required":false,"description":"How many videos to return, up to 100 (Twitch allows no paging past the first 100 without a browser session, so the response has no cursor).","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"twitch.user.videos","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"A channel's videos (up to 100): id, title, views, game, duration and thumbnails.","x-examples":[{"handle":"shroud"}]}},"/v1/twitch/user/schedule":{"get":{"operationId":"twitch.user.schedule","summary":"Twitch stream schedule","tags":["twitch"],"parameters":[{"name":"handle","in":"query","required":true,"description":"Username, with or without the leading @.","schema":{"type":"string"},"x-aliases":["username"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Event__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"twitch.user.schedule","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"A channel's scheduled streams: start and end time, title, categories and whether a stream is cancelled.","x-examples":[{"handle":"emongg"}]}},"/v1/twitch/clip/transcript":{"get":{"operationId":"twitch.clip.transcript","summary":"Twitch clip transcript","tags":["twitch"],"parameters":[{"name":"url","in":"query","required":true,"description":"Clip URL (clips.twitch.tv/... or twitch.tv/<user>/clip/...).","schema":{"type":"string","format":"uri"},"x-hosts":["twitch.tv"]},{"name":"allow_long_transcription","in":"query","required":false,"description":"Transcribe audio past 2 minutes with AI, at 5 credits per started minute of the whole video. Without it a longer video answers transcript_unavailable, which is free.","schema":{"type":"boolean","default":false},"x-aliases":["allowLongTranscription"]},{"name":"ai_fallback","in":"query","required":false,"description":"Transcribe the audio with AI when the clip has no captions. Set false to get no transcript instead, and no AI charge.","schema":{"type":"boolean","default":true},"x-aliases":["use_ai_as_fallback"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit for captions; AI transcription 1 up to 2 minutes, then 5 per started minute of the whole video.","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Transcript_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"twitch.clip.transcript","x-credits":"transcript","x-credit-rule":"1 credit for captions; AI transcription 1 up to 2 minutes, then 5 per started minute of the whole video","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":120,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Native captions when the clip has them; AI transcription of the clip's audio when it does not.","x-examples":[{"url":"https://www.twitch.tv/mish/clip/WrongMagnificentTomatoCorgiDerp-C720OEMqocSPbrqA"}]}},"/v1/twitch/clip":{"get":{"operationId":"twitch.clip","summary":"Twitch clip","tags":["twitch"],"parameters":[{"name":"url","in":"query","required":true,"description":"Clip URL (clips.twitch.tv/... or twitch.tv/<user>/clip/...).","schema":{"type":"string","format":"uri"},"x-hosts":["twitch.tv"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Post_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"twitch.clip","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"x-examples":[{"url":"https://www.twitch.tv/mish/clip/WrongMagnificentTomatoCorgiDerp-C720OEMqocSPbrqA"}]}},"/v1/kick/clip/transcript":{"get":{"operationId":"kick.clip.transcript","summary":"Kick clip transcript","tags":["kick"],"parameters":[{"name":"url","in":"query","required":true,"description":"Clip URL (kick.com/<user>/clips/clip_...).","schema":{"type":"string","format":"uri"},"x-hosts":["kick.com"]},{"name":"allow_long_transcription","in":"query","required":false,"description":"Transcribe audio past 2 minutes with AI, at 5 credits per started minute of the whole video. Without it a longer video answers transcript_unavailable, which is free.","schema":{"type":"boolean","default":false},"x-aliases":["allowLongTranscription"]},{"name":"ai_fallback","in":"query","required":false,"description":"Transcribe the audio with AI when the clip has no captions. Set false to get no transcript instead, and no AI charge.","schema":{"type":"boolean","default":true},"x-aliases":["use_ai_as_fallback"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit for captions; AI transcription 1 up to 2 minutes, then 5 per started minute of the whole video.","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Transcript_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"kick.clip.transcript","x-credits":"transcript","x-credit-rule":"1 credit for captions; AI transcription 1 up to 2 minutes, then 5 per started minute of the whole video","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":120,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Kick clips carry no caption track, so this is AI transcription of the clip's audio (flat 1 credit for clips of up to two minutes). With ai_fallback=false nothing is transcribed and nothing is charged.","x-examples":[{"url":"https://kick.com/xqc/clips/clip_01JGJHB6CEVFCQRYTVPM8DW892"}]}},"/v1/kick/clip":{"get":{"operationId":"kick.clip","summary":"Kick clip","tags":["kick"],"parameters":[{"name":"url","in":"query","required":true,"description":"Clip URL (kick.com/<user>/clips/clip_...).","schema":{"type":"string","format":"uri"},"x-hosts":["kick.com"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Post_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"kick.clip","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"x-examples":[{"url":"https://kick.com/xqc/clips/clip_01JGJHB6CEVFCQRYTVPM8DW892"}]}},"/v1/snapchat/profile":{"get":{"operationId":"snapchat.profile","summary":"Snapchat public profile","tags":["snapchat"],"parameters":[{"name":"handle","in":"query","required":true,"description":"Username, with or without the leading @.","schema":{"type":"string"},"x-aliases":["username"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Profile_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"snapchat.profile","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"A public profile (snapchat.com/add/<handle>): name, bio, subscribers, public stories where shown.","x-examples":[{"handle":"zane"}]}},"/v1/snapchat/spotlight":{"get":{"operationId":"snapchat.spotlight","summary":"Snapchat Spotlight video","tags":["snapchat"],"parameters":[{"name":"url","in":"query","required":true,"description":"Spotlight URL (snapchat.com/@user/spotlight/...).","schema":{"type":"string","format":"uri"},"x-hosts":["snapchat.com"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Post_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"snapchat.spotlight","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"One public Spotlight video by link: id, description, creator, engagement counts, thumbnail and content URL, where Snapchat shows them.","x-examples":[{"url":"https://www.snapchat.com/@jack.scalise/spotlight/W7_EDlXWTBiXAEEniNoMPwAAYb3djZ3FqY2VhAZXDhShdAZXDhPWfAAAAAQ"}]}},"/v1/snapchat/spotlight/comments":{"get":{"operationId":"snapchat.spotlight.comments","summary":"Snapchat Spotlight comments","tags":["snapchat"],"parameters":[{"name":"url","in":"query","required":true,"description":"Spotlight URL (snapchat.com/@user/spotlight/...).","schema":{"type":"string","format":"uri"},"x-hosts":["snapchat.com"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Comment__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"snapchat.spotlight.comments","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Public comments on a Spotlight video; `parent` is the video. Pass the cursor back for more.","x-examples":[{"url":"https://www.snapchat.com/@jack.scalise/spotlight/W7_EDlXWTBiXAEEniNoMPwAAYb3djZ3FqY2VhAZXDhShdAZXDhPWfAAAAAQ"}]}},"/v1/linktree":{"get":{"operationId":"linktree","summary":"Linktree page","tags":["linktree"],"parameters":[{"name":"url","in":"query","required":false,"description":"Linktree page URL.","schema":{"type":"string","format":"uri"},"x-hosts":["linktr.ee"]},{"name":"handle","in":"query","required":false,"description":"Linktree username.","schema":{"type":"string"},"x-aliases":["username"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_LinkPage_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"linktree","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"A Linktree page: the creator's name, bio, avatar, every link in page order and the social accounts it points to. Product and group links carry their type, thumbnail and price in `extra.link_details`; a published email is in `extra.emails` and `socials`. Pass the page `url` or just the `handle`.","x-one-of":[["url","handle"]],"x-examples":[{"url":"https://linktr.ee/miguelangeles"}]}},"/v1/komi":{"get":{"operationId":"komi","summary":"Komi page","tags":["komi"],"parameters":[{"name":"url","in":"query","required":false,"description":"Komi page URL.","schema":{"type":"string","format":"uri"},"x-hosts":["komi.io"]},{"name":"handle","in":"query","required":false,"description":"Komi username.","schema":{"type":"string"},"x-aliases":["username"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_LinkPage_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"komi","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"A Komi page: the creator's name, bio, avatar, every link in page order and the social accounts it points to. Hidden modules are left out; products carry their price in `extra.link_details`. Pass the page `url` or just the `handle`.","x-one-of":[["url","handle"]],"x-examples":[{"url":"https://kimkardashian.komi.io/"}]}},"/v1/pillar":{"get":{"operationId":"pillar","summary":"Pillar page","tags":["pillar"],"parameters":[{"name":"url","in":"query","required":false,"description":"Pillar page URL.","schema":{"type":"string","format":"uri"},"x-hosts":["pillar.io"]},{"name":"handle","in":"query","required":false,"description":"Pillar username.","schema":{"type":"string"},"x-aliases":["username"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_LinkPage_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"pillar","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"A Pillar page: the creator's name, bio, avatar, every link in page order and the social accounts it points to. Links and products are listed together; the email is the one the creator shows on the page. Pass the page `url` or just the `handle`.","x-one-of":[["url","handle"]],"x-examples":[{"url":"https://pillar.io/angelstrife"}]}},"/v1/linkbio":{"get":{"operationId":"linkbio","summary":"Lnk.Bio page","tags":["linkbio"],"parameters":[{"name":"url","in":"query","required":false,"description":"Lnk.Bio page URL.","schema":{"type":"string","format":"uri"},"x-hosts":["lnk.bio"]},{"name":"handle","in":"query","required":false,"description":"Lnk.Bio username.","schema":{"type":"string"},"x-aliases":["username"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_LinkPage_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"linkbio","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"A Lnk.Bio page: the creator's name, bio, avatar, every link in page order and the social accounts it points to. Lnk.Bio only serves browser-like clients, so this one is slower. Pass the page `url` or just the `handle`.","x-one-of":[["url","handle"]],"x-examples":[{"url":"https://lnk.bio/msjennafischer"}]}},"/v1/linkme":{"get":{"operationId":"linkme","summary":"Linkme page","tags":["linkme"],"parameters":[{"name":"url","in":"query","required":false,"description":"Linkme page URL.","schema":{"type":"string","format":"uri"},"x-hosts":["link.me"]},{"name":"handle","in":"query","required":false,"description":"Linkme username.","schema":{"type":"string"},"x-aliases":["username"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_LinkPage_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"linkme","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"A Linkme page: the creator's name, bio, avatar, every link in page order and the social accounts it points to. Contact emails come from the page's contact section. Pass the page `url` or just the `handle`.","x-one-of":[["url","handle"]],"x-examples":[{"url":"https://link.me/danucd"}]}},"/v1/creators/social-profiles":{"get":{"operationId":"creators.social_profiles","summary":"Find a creator's other social profiles","tags":["web"],"parameters":[{"name":"url","in":"query","required":false,"description":"Profile URL on any supported platform.","schema":{"type":"string","format":"uri"},"x-hosts":["youtube.com","tiktok.com","instagram.com","x.com","twitter.com","twitch.tv","facebook.com","linktr.ee","komi.io","pillar.io","lnk.bio","link.me"]},{"name":"handle","in":"query","required":false,"description":"Handle without a profile URL; needs `platform`.","schema":{"type":"string"},"x-aliases":["username"]},{"name":"platform","in":"query","required":false,"description":"Platform of `handle`.","schema":{"type":"string","enum":["youtube","tiktok","instagram","twitter","twitch","facebook"]},"x-value-aliases":{"x":"twitter"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Profile__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"creators.social_profiles","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":60,"x-cache":{"cacheable":true,"ttl_days":30},"description":"The social profiles a creator links from their own bio, links section or link-in-bio page, each as a profile with its platform and URL; `extra.evidence` lists the pages that say so and `extra.confidence` is 1.0 for a link on the profile itself, 0.9 for one a link-in-bio page or a linked profile declares. Only links the creator published are followed; nothing is guessed from a matching handle. Pass a `platform` and a bare `handle` (a leading @ is optional; YouTube also takes a channel id), or a profile `url`.","x-one-of":[["url","handle"]],"x-examples":[{"handle":"MrBeast","platform":"youtube"}],"x-aliases":["/v1/find-social-profiles"]}},"/v1/creators/emails":{"get":{"operationId":"creators.emails","summary":"Find a creator's public emails","tags":["web"],"parameters":[{"name":"url","in":"query","required":false,"description":"Profile URL on any supported platform.","schema":{"type":"string","format":"uri"},"x-hosts":["youtube.com","tiktok.com","instagram.com","x.com","twitter.com","twitch.tv","facebook.com","linktr.ee","komi.io","pillar.io","lnk.bio","link.me"]},{"name":"handle","in":"query","required":false,"description":"Handle; needs `platform`.","schema":{"type":"string"},"x-aliases":["username"]},{"name":"platform","in":"query","required":false,"description":"Platform of `handle`.","schema":{"type":"string","enum":["youtube","tiktok","instagram","twitter","twitch","facebook"]},"x-value-aliases":{"x":"twitter"}},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_CreatorEmails_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"creators.emails","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":60,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Email addresses a creator published themselves, each with the URLs where it was seen (`extra.email_sources`, each typed social_profile, link_in_bio, linked_profile or website_page). Reads the creator's bio and links, the link-in-bio pages they link (Linktree, Komi, Pillar, Lnk.Bio, Linkme and other link hubs), the profiles they link, and up to three websites they declare (homepage and contact pages, robots.txt honoured). Addresses are never guessed or checked by sending mail; `kind` is business, management or personal when the address itself says so. `extra.partial` is true when a page failed or was skipped, so an empty result is then not proof that no address exists. Pass a `platform` and `handle`, or a profile `url`.","x-one-of":[["url","handle"]],"x-examples":[{"platform":"instagram","handle":"miguelangeles"}],"x-aliases":["/v1/find-creator-emails"]}},"/v1/facebook/ad-library/search":{"get":{"operationId":"facebook.ad_library.search","summary":"Facebook Ad Library search","tags":["facebook"],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword to search for.","schema":{"type":"string"},"x-aliases":["keyword","q"]},{"name":"sort","in":"query","required":false,"description":"Order of results: `impressions` is most impressions first (ScrapeCreators' default), `newest` is most recent. Changing it restarts the cursor chain.","schema":{"type":"string","enum":["relevance","impressions","newest"]},"x-aliases":["sort_by","sortBy","order"],"x-value-aliases":{"total_impressions":"impressions","relevancy_monthly_grouped":"newest"}},{"name":"match","in":"query","required":false,"description":"Match any of the words, or the exact phrase.","schema":{"type":"string","enum":["any_words","exact_phrase"],"default":"any_words"},"x-aliases":["search_type"],"x-value-aliases":{"keyword_unordered":"any_words","keyword_exact_phrase":"exact_phrase"}},{"name":"ad_type","in":"query","required":false,"description":"All ads, or only political and issue ads.","schema":{"type":"string","enum":["all","political"],"default":"all"},"x-value-aliases":{"political_and_issue_ads":"political"}},{"name":"language","in":"query","required":false,"description":"Only ads in this language, a 2-letter code (EN, ES, FR).","schema":{"type":"string"},"x-aliases":["lang"]},{"name":"status","in":"query","required":false,"description":"Ad status.","schema":{"type":"string","enum":["active","inactive","all"],"default":"active"},"x-aliases":["active_status"],"x-value-aliases":{"ACTIVE":"active","INACTIVE":"inactive","ALL":"all"}},{"name":"media_type","in":"query","required":false,"description":"Creative type. `meme` is Meta's word for text on an image.","schema":{"type":"string","enum":["all","image","video","meme","image_and_meme","none"]},"x-value-aliases":{"ALL":"all","IMAGE":"image","VIDEO":"video","MEME":"meme","IMAGE_AND_MEME":"image_and_meme","NONE":"none"}},{"name":"start_date","in":"query","required":false,"description":"Impressions window start, YYYY-MM-DD.","schema":{"type":"string"}},{"name":"end_date","in":"query","required":false,"description":"Impressions window end, YYYY-MM-DD.","schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"region","in":"query","required":false,"description":"Two-letter country code (ISO 3166-1) for results that vary by country.","schema":{"type":"string"},"example":"US","x-aliases":["country","geo"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Ad__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"facebook.ad_library.search","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"ads","x-mode":"sync","x-timeout-seconds":60,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Search the Meta Ad Library by keyword. `region` is the one country to search (ALL for every country). Also available as POST with a JSON body, for cursors too long for a URL.","x-examples":[{"query":"running shoes","region":"US"}],"x-aliases":["/v1/facebook/adLibrary/search/ads"]},"post":{"operationId":"facebook.ad_library.search.post","summary":"Facebook Ad Library search (POST body)","tags":["facebook"],"parameters":[{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"region","in":"query","required":false,"description":"Two-letter country code (ISO 3166-1) for results that vary by country.","schema":{"type":"string"},"example":"US","x-aliases":["country","geo"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]},{"name":"Idempotency-Key","in":"header","required":false,"description":"Send the same value when retrying: the first answer is returned and nothing is charged twice. Kept 24 hours.","schema":{"type":"string","maxLength":255}}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Ad__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"facebook.ad_library.search.post","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"ads","x-mode":"sync","x-timeout-seconds":60,"x-cache":{"cacheable":true,"ttl_days":30},"description":"The same as the GET form, with the parameters in a JSON body.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["query"],"properties":{"query":{"type":"string","description":"Keyword to search for."},"sort":{"type":"string","enum":["relevance","impressions","newest"],"description":"Order of results: `impressions` is most impressions first (ScrapeCreators' default), `newest` is most recent. Changing it restarts the cursor chain."},"match":{"type":"string","enum":["any_words","exact_phrase"],"default":"any_words","description":"Match any of the words, or the exact phrase."},"ad_type":{"type":"string","enum":["all","political"],"default":"all","description":"All ads, or only political and issue ads."},"language":{"type":"string","description":"Only ads in this language, a 2-letter code (EN, ES, FR)."},"status":{"type":"string","enum":["active","inactive","all"],"default":"active","description":"Ad status."},"media_type":{"type":"string","enum":["all","image","video","meme","image_and_meme","none"],"description":"Creative type. `meme` is Meta's word for text on an image."},"start_date":{"type":"string","description":"Impressions window start, YYYY-MM-DD."},"end_date":{"type":"string","description":"Impressions window end, YYYY-MM-DD."}}}}}},"x-examples":[{"query":"running shoes","region":"US"}],"x-aliases":["/v1/facebook/adLibrary/search/ads"]}},"/v1/facebook/ad-library/company/ads":{"get":{"operationId":"facebook.ad_library.company.ads","summary":"Facebook Ad Library ads by page","tags":["facebook"],"parameters":[{"name":"id","in":"query","required":false,"description":"Ad Library page id of the advertiser (from advertiser search).","schema":{"type":"string"},"x-aliases":["pageId","page_id"]},{"name":"company_name","in":"query","required":false,"description":"Advertiser name (resolved to a page id).","schema":{"type":"string"},"x-aliases":["companyName"]},{"name":"status","in":"query","required":false,"description":"Ad status.","schema":{"type":"string","enum":["active","inactive","all"],"default":"active"},"x-aliases":["active_status"],"x-value-aliases":{"ACTIVE":"active","INACTIVE":"inactive","ALL":"all"}},{"name":"media_type","in":"query","required":false,"description":"Creative type. `meme` is Meta's word for text on an image.","schema":{"type":"string","enum":["all","image","video","meme","image_and_meme","none"]},"x-value-aliases":{"ALL":"all","IMAGE":"image","VIDEO":"video","MEME":"meme","IMAGE_AND_MEME":"image_and_meme","NONE":"none"}},{"name":"language","in":"query","required":false,"description":"Only ads in this language, a 2-letter code (EN, ES, FR).","schema":{"type":"string"},"x-aliases":["lang"]},{"name":"sort","in":"query","required":false,"description":"Order of results: `impressions` is most impressions first (ScrapeCreators' default), `newest` is most recent. Changing it restarts the cursor chain.","schema":{"type":"string","enum":["relevance","impressions","newest"]},"x-aliases":["sort_by","sortBy","order"],"x-value-aliases":{"total_impressions":"impressions","relevancy_monthly_grouped":"newest"}},{"name":"start_date","in":"query","required":false,"description":"Impressions window start, YYYY-MM-DD.","schema":{"type":"string"}},{"name":"end_date","in":"query","required":false,"description":"Impressions window end, YYYY-MM-DD.","schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"region","in":"query","required":false,"description":"Two-letter country code (ISO 3166-1) for results that vary by country.","schema":{"type":"string"},"example":"US","x-aliases":["country","geo"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Ad__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"facebook.ad_library.company.ads","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"ads","x-mode":"sync","x-timeout-seconds":90,"x-cache":{"cacheable":true,"ttl_days":30},"description":"The ads a company runs, by Ad Library page id or by company name. Also available as POST with a JSON body.","x-one-of":[["id","company_name"]],"x-examples":[{"company_name":"Nike"}],"x-aliases":["/v1/facebook/adLibrary/company/ads"]},"post":{"operationId":"facebook.ad_library.company.ads.post","summary":"Facebook Ad Library ads by page (POST body)","tags":["facebook"],"parameters":[{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"region","in":"query","required":false,"description":"Two-letter country code (ISO 3166-1) for results that vary by country.","schema":{"type":"string"},"example":"US","x-aliases":["country","geo"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]},{"name":"Idempotency-Key","in":"header","required":false,"description":"Send the same value when retrying: the first answer is returned and nothing is charged twice. Kept 24 hours.","schema":{"type":"string","maxLength":255}}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Ad__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"facebook.ad_library.company.ads.post","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"ads","x-mode":"sync","x-timeout-seconds":90,"x-cache":{"cacheable":true,"ttl_days":30},"description":"The same as the GET form, with the parameters in a JSON body.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"id":{"type":"string","description":"Ad Library page id of the advertiser (from advertiser search)."},"company_name":{"type":"string","description":"Advertiser name (resolved to a page id)."},"status":{"type":"string","enum":["active","inactive","all"],"default":"active","description":"Ad status."},"media_type":{"type":"string","enum":["all","image","video","meme","image_and_meme","none"],"description":"Creative type. `meme` is Meta's word for text on an image."},"language":{"type":"string","description":"Only ads in this language, a 2-letter code (EN, ES, FR)."},"sort":{"type":"string","enum":["relevance","impressions","newest"],"description":"Order of results: `impressions` is most impressions first (ScrapeCreators' default), `newest` is most recent. Changing it restarts the cursor chain."},"start_date":{"type":"string","description":"Impressions window start, YYYY-MM-DD."},"end_date":{"type":"string","description":"Impressions window end, YYYY-MM-DD."}}}}}},"x-one-of":[["id","company_name"]],"x-examples":[{"company_name":"Nike"}],"x-aliases":["/v1/facebook/adLibrary/company/ads"]}},"/v1/facebook/ad-library/ad":{"get":{"operationId":"facebook.ad_library.ad","summary":"Facebook Ad Library ad details","tags":["facebook"],"parameters":[{"name":"id","in":"query","required":false,"description":"Ad id in the library.","schema":{"type":"string"},"x-aliases":["ad_id","adId"]},{"name":"url","in":"query","required":false,"description":"Ad Library URL (facebook.com/ads/library/?id=...).","schema":{"type":"string","format":"uri"},"x-hosts":["facebook.com"]},{"name":"get_transcript","in":"query","required":false,"description":"Accepted for compatibility. A video ad's transcript is its own call, `ad/transcript` (AI transcription, metered); this flag only adds a pointer to it in `extra.transcript_hint`.","schema":{"type":"boolean","default":false}},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Ad_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"facebook.ad_library.ad","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"ads","x-mode":"sync","x-timeout-seconds":60,"x-cache":{"cacheable":true,"ttl_days":30},"description":"One ad by id or URL: page, status, dates and the snapshot (text, images, videos, format, link, call to action). Regulated ads add their transparency data in `extra`.","x-one-of":[["id","url"]],"x-examples":[{"id":"352695862528588"}],"x-aliases":["/v1/facebook/adLibrary/ad"]}},"/v1/facebook/ad-library/ad/transcript":{"get":{"operationId":"facebook.ad_library.ad.transcript","summary":"Facebook Ad Library ad transcript","tags":["facebook"],"parameters":[{"name":"id","in":"query","required":false,"description":"Ad id in the library.","schema":{"type":"string"},"x-aliases":["ad_id","adId"]},{"name":"url","in":"query","required":false,"description":"Ad Library URL (facebook.com/ads/library/?id=...).","schema":{"type":"string","format":"uri"},"x-hosts":["facebook.com"]},{"name":"allow_long_transcription","in":"query","required":false,"description":"Transcribe audio past 2 minutes with AI, at 5 credits per started minute of the whole video. Without it a longer video answers transcript_unavailable, which is free.","schema":{"type":"boolean","default":false},"x-aliases":["allowLongTranscription"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit for captions; AI transcription 1 up to 2 minutes, then 5 per started minute of the whole video.","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Transcript_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"facebook.ad_library.ad.transcript","x-credits":"transcript","x-credit-rule":"1 credit for captions; AI transcription 1 up to 2 minutes, then 5 per started minute of the whole video","x-status":"ga","x-pool":"ads","x-mode":"sync","x-timeout-seconds":180,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Transcript of a video ad. Ad Library videos carry no caption tracks, so this is always AI transcription of the audio, billed by the length of the audio. An ad with no video answers an unbilled error.","x-one-of":[["id","url"]],"x-examples":[{"id":"4103518759887460"}],"x-aliases":["/v1/facebook/adLibrary/ad/transcript"]}},"/v1/facebook/ad-library/search/companies":{"get":{"operationId":"facebook.ad_library.search.companies","summary":"Facebook Ad Library advertiser search","tags":["facebook"],"parameters":[{"name":"query","in":"query","required":true,"description":"Search terms.","schema":{"type":"string"},"x-aliases":["keyword","q"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Advertiser__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"facebook.ad_library.search.companies","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"ads","x-mode":"sync","x-timeout-seconds":90,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Advertisers matching a name: Ad Library page id, category, likes, verification and Instagram details. Use the page id with `company/ads`. Meta closes its advertiser typeahead, so these are the pages behind the ads a search for the name returns (up to 10, name matches first), each completed from the ad-details query; `ad_count` is not available.","x-examples":[{"query":"nike"}],"x-aliases":["/v1/facebook/adLibrary/search/companies"]}},"/v1/google/ad-library/advertisers/search":{"get":{"operationId":"google.ad_library.advertisers.search","summary":"Google Ads Transparency advertiser search","tags":["google"],"parameters":[{"name":"query","in":"query","required":true,"description":"Search terms.","schema":{"type":"string"},"x-aliases":["keyword","q"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"region","in":"query","required":false,"description":"Two-letter country code (ISO 3166-1) for results that vary by country.","schema":{"type":"string"},"example":"US","x-aliases":["country","geo"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Advertiser__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"google.ad_library.advertisers.search","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"ads","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"x-examples":[{"query":"nike"}],"x-aliases":["/v1/google/adLibrary/advertisers/search"]}},"/v1/google/ad-library/company/ads":{"get":{"operationId":"google.ad_library.company.ads","summary":"Google Ads Transparency ads by advertiser","tags":["google"],"parameters":[{"name":"id","in":"query","required":false,"description":"Advertiser id (AR...).","schema":{"type":"string"},"x-aliases":["advertiser_id","advertiserId"]},{"name":"domain","in":"query","required":false,"description":"Advertiser's website domain.","schema":{"type":"string"}},{"name":"topic","in":"query","required":false,"description":"All ads or political ads. Political needs a `region`.","schema":{"type":"string","enum":["all","political"]}},{"name":"platform","in":"query","required":false,"description":"Where the ad ran.","schema":{"type":"string","enum":["google_maps","google_play","google_search","google_shopping","youtube"]}},{"name":"format","in":"query","required":false,"description":"Creative format.","schema":{"type":"string","enum":["all","text","image","video"]}},{"name":"start_date","in":"query","required":false,"description":"Ads shown from this date, YYYY-MM-DD.","schema":{"type":"string"}},{"name":"end_date","in":"query","required":false,"description":"Ads shown up to this date, YYYY-MM-DD.","schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"region","in":"query","required":false,"description":"Two-letter country code (ISO 3166-1) for results that vary by country.","schema":{"type":"string"},"example":"US","x-aliases":["country","geo"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Ad__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"google.ad_library.company.ads","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"ads","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"An advertiser's public ads by advertiser id or website domain: ids, previews and first and last shown dates when Google gives them.","x-one-of":[["id","domain"]],"x-examples":[{"domain":"nike.com"}],"x-aliases":["/v1/google/company/ads"]}},"/v1/google/ad-library/ad":{"get":{"operationId":"google.ad_library.ad","summary":"Google Ads Transparency ad details","tags":["google"],"parameters":[{"name":"url","in":"query","required":true,"description":"Creative URL (adstransparency.google.com/advertiser/AR.../creative/CR...).","schema":{"type":"string","format":"uri"},"x-hosts":["adstransparency.google.com"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Ad_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"google.ad_library.ad","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"ads","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"x-examples":[{"url":"https://adstransparency.google.com/advertiser/AR16735076323512287233/creative/CR17814369753519620097"}],"x-aliases":["/v1/google/ad"]}},"/v1/linkedin/ad-library/search":{"get":{"operationId":"linkedin.ad_library.search","summary":"LinkedIn Ad Library search","tags":["linkedin"],"parameters":[{"name":"query","in":"query","required":false,"description":"Keyword to search for.","schema":{"type":"string"},"x-aliases":["keyword","q"]},{"name":"company","in":"query","required":false,"description":"Advertiser name.","schema":{"type":"string"},"x-aliases":["company_name"]},{"name":"company_id","in":"query","required":false,"description":"LinkedIn company id: the number in linkedin.com/company/<id>.","schema":{"type":"string"},"x-aliases":["companyId"]},{"name":"countries","in":"query","required":false,"description":"Comma-separated 2-letter countries, \"US,CA,MX\".","schema":{"type":"string"}},{"name":"start_date","in":"query","required":false,"description":"Start date, YYYY-MM-DD. Use with `end_date`.","schema":{"type":"string"},"x-aliases":["startDate"]},{"name":"end_date","in":"query","required":false,"description":"End date, YYYY-MM-DD. Use with `start_date`.","schema":{"type":"string"},"x-aliases":["endDate"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"region","in":"query","required":false,"description":"Two-letter country code (ISO 3166-1) for results that vary by country.","schema":{"type":"string"},"example":"US","x-aliases":["country","geo"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Ad__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"linkedin.ad_library.search","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"ads","x-mode":"sync","x-timeout-seconds":90,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Search the LinkedIn Ad Library by company name, company id or keyword (give at least one). Custom dates need both `start_date` and `end_date`, within the past year and ending yesterday at the latest. `countries` is a comma-separated list; the cursor is LinkedIn's pagination token.","x-examples":[{"company":"Microsoft"}],"x-aliases":["/v1/linkedin/ads/search"]}},"/v1/linkedin/ad-library/ad":{"get":{"operationId":"linkedin.ad_library.ad","summary":"LinkedIn Ad Library ad details","tags":["linkedin"],"parameters":[{"name":"url","in":"query","required":false,"description":"Ad URL (linkedin.com/ad-library/detail/...).","schema":{"type":"string","format":"uri"},"x-hosts":["linkedin.com"]},{"name":"id","in":"query","required":false,"description":"Ad id in the library.","schema":{"type":"string"},"x-aliases":["ad_id","adId"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Ad_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"linkedin.ad_library.ad","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"ads","x-mode":"sync","x-timeout-seconds":90,"x-cache":{"cacheable":true,"ttl_days":30},"x-one-of":[["url","id"]],"x-examples":[{"id":"1662766106"}],"x-aliases":["/v1/linkedin/ad"]}},"/v1/reddit/ad-library/search":{"get":{"operationId":"reddit.ad_library.search","summary":"Reddit ads search","tags":["reddit"],"parameters":[{"name":"query","in":"query","required":true,"description":"Search terms.","schema":{"type":"string"},"x-aliases":["keyword","q"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Ad__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"reddit.ad_library.search","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"stub","x-pool":"ads","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Not available. Reddit serves its ads library behind an anti-bot verification page, which we do not answer, so there is no route to it. Declared so the path is reserved.","x-examples":[{"query":"vpn"}]}},"/v1/reddit/ad-library/ad":{"get":{"operationId":"reddit.ad_library.ad","summary":"Reddit ad details","tags":["reddit"],"parameters":[{"name":"id","in":"query","required":false,"description":"Ad id in the library.","schema":{"type":"string"},"x-aliases":["ad_id","adId"]},{"name":"url","in":"query","required":false,"description":"Ad URL.","schema":{"type":"string","format":"uri"},"x-hosts":["reddit.com"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Ad_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"reddit.ad_library.ad","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"stub","x-pool":"ads","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Not available, for the same reason as Reddit ads search.","x-one-of":[["id","url"]],"x-examples":[{"id":"replace-me"}]}},"/v1/tiktok/ad-library/search":{"get":{"operationId":"tiktok.ad_library.search","summary":"TikTok Ad Library search","tags":["tiktok"],"parameters":[{"name":"query","in":"query","required":false,"description":"General ad search.","schema":{"type":"string"},"x-aliases":["keyword","q"]},{"name":"advertiser_name","in":"query","required":false,"description":"Advertiser name to resolve and search by advertiser entity.","schema":{"type":"string"}},{"name":"adv_biz_ids","in":"query","required":false,"description":"TikTok advertiser business id from a See all ads link; pins the exact advertiser. Only works together with `advertiser_name`.","schema":{"type":"string"}},{"name":"start_date","in":"query","required":false,"description":"Ads shown from this date, YYYY-MM-DD (default: a year before `end_date`).","schema":{"type":"string"}},{"name":"end_date","in":"query","required":false,"description":"Ads shown up to this date, YYYY-MM-DD (default: today).","schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"region","in":"query","required":false,"description":"Two-letter country code (ISO 3166-1) for results that vary by country.","schema":{"type":"string"},"example":"US","x-aliases":["country","geo"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Ad__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"tiktok.ad_library.search","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"ads","x-mode":"sync","x-timeout-seconds":60,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Search TikTok's public Ads Library by keyword (`query`, or a quoted \"exact phrase\") or by advertiser (`advertiser_name`, resolved through TikTok's typeahead). Give one of the two. The library is TikTok's European commercial-content library: it lists ads shown in the EU, EEA, UK and Switzerland, 12 per page, newest shown first. `region` is one of those countries (default all).","x-one-of":[["query","advertiser_name"]],"x-examples":[{"query":"skincare","region":"FR"}]}},"/v1/tiktok/ad-library/ad":{"get":{"operationId":"tiktok.ad_library.ad","summary":"TikTok Ad Library ad details","tags":["tiktok"],"parameters":[{"name":"id","in":"query","required":false,"description":"Ad id in the library.","schema":{"type":"string"},"x-aliases":["ad_id","adId"]},{"name":"url","in":"query","required":false,"description":"Ad URL (library.tiktok.com/ads/detail/?ad_id=...).","schema":{"type":"string","format":"uri"},"x-hosts":["library.tiktok.com","tiktok.com"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Ad_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"tiktok.ad_library.ad","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"ads","x-mode":"sync","x-timeout-seconds":60,"x-cache":{"cacheable":true,"ttl_days":30},"description":"One ad from TikTok's European Ads Library: the creative, the advertiser (business id, registry country) and the targeting with impressions by region, age and gender, as the library shows them.","x-one-of":[["id","url"]],"x-examples":[{"id":"1879687389944914"}]}},"/v1/twitter/search/posts":{"get":{"operationId":"twitter.search.posts","summary":"X post search","tags":["twitter"],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword or phrase to look for in public X posts.","schema":{"type":"string"},"x-aliases":["keyword","q"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"twitter.search.posts","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"x","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Public posts found through a web search engine (DuckDuckGo, restricted to x.com), then read like `tweet` through X's public post widget, so views, retweet and bookmark counts are missing. This is engine-indexed discovery, not X's own search (which needs a login): coverage is incomplete, recent posts can be missing and the order is the engine's. Deleted, protected and unreachable posts are left out. Cursor pages 1 to 11.","x-examples":[{"query":"ai agents"}]}},"/v1/twitter/profile":{"get":{"operationId":"twitter.profile","summary":"X profile","tags":["twitter"],"parameters":[{"name":"handle","in":"query","required":true,"description":"Username, with or without the leading @.","schema":{"type":"string"},"x-aliases":["username","screen_name"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Profile_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"twitter.profile","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"x","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Account details: bio, links, avatar, banner, followers, following, post count and verification. X no longer shows the account's likes or listed counts, so `stats.likes` is empty. If X will not serve the profile page, the account is read from its public timeline widget instead (`extra.source` is `syndication`): no birthdate, verification reason or highlights, and it needs the account to have posts of its own. Suspended accounts answer removed, unknown ones not_found.","x-examples":[{"handle":"nasa"}]}},"/v1/twitter/profile/tweets":{"get":{"operationId":"twitter.profile.tweets","summary":"X profile posts","tags":["twitter"],"parameters":[{"name":"handle","in":"query","required":true,"description":"Username, with or without the leading @.","schema":{"type":"string"},"x-aliases":["username","screen_name"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"twitter.profile.tweets","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"x","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Posts of an account: about 20 popular posts and reposts, or, when X's public timeline widget is rate limited, the 5 newest original posts. X offers no way to page further, so there is no next-page cursor.","x-examples":[{"handle":"nasa"}],"x-aliases":["/v1/twitter/user-tweets"]}},"/v1/twitter/tweet":{"get":{"operationId":"twitter.tweet","summary":"X post details","tags":["twitter"],"parameters":[{"name":"url","in":"query","required":false,"description":"Post URL (x.com/<user>/status/<id>).","schema":{"type":"string","format":"uri"},"x-hosts":["x.com","twitter.com"]},{"name":"id","in":"query","required":false,"description":"Post id.","schema":{"type":"string"},"x-aliases":["tweet_id"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Post_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"twitter.tweet","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"x","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"One public post with its counts, media and, for a quote post, the quoted post (`extra.quoted_post`). If X will not serve the post page, the answer comes from X's public post widget instead and views, retweet and bookmark counts are missing (`extra.source_shape` is `syndication`).","x-one-of":[["url","id"]],"x-examples":[{"url":"https://x.com/jack/status/20"}]}},"/v1/twitter/tweet/transcript":{"get":{"operationId":"twitter.tweet.transcript","summary":"X video transcript","tags":["twitter"],"parameters":[{"name":"url","in":"query","required":false,"description":"Post URL (x.com/<user>/status/<id>).","schema":{"type":"string","format":"uri"},"x-hosts":["x.com","twitter.com"]},{"name":"id","in":"query","required":false,"description":"Post id.","schema":{"type":"string"},"x-aliases":["tweet_id"]},{"name":"allow_long_transcription","in":"query","required":false,"description":"Transcribe audio past 2 minutes with AI, at 5 credits per started minute of the whole video. Without it a longer video answers transcript_unavailable, which is free.","schema":{"type":"boolean","default":false},"x-aliases":["allowLongTranscription"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit for captions; AI transcription 1 up to 2 minutes, then 5 per started minute of the whole video.","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Transcript_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"twitter.tweet.transcript","x-credits":"transcript","x-credit-rule":"1 credit for captions; AI transcription 1 up to 2 minutes, then 5 per started minute of the whole video","x-status":"ga","x-pool":"x","x-mode":"sync","x-timeout-seconds":180,"x-cache":{"cacheable":true,"ttl_days":30},"description":"AI transcription of the video in a post. Videos over 2 minutes need allow_long_transcription=true and cost 5 credits per started minute of the whole video. Posts without video, and animated GIFs, answer transcript_unavailable (free).","x-one-of":[["url","id"]],"x-examples":[{"url":"https://x.com/coinbase/status/2066970874016645585"}]}},"/v1/twitter/community":{"get":{"operationId":"twitter.community","summary":"X community","tags":["twitter"],"parameters":[{"name":"url","in":"query","required":false,"description":"Community URL (x.com/i/communities/<id>).","schema":{"type":"string","format":"uri"},"x-hosts":["x.com","twitter.com"]},{"name":"id","in":"query","required":false,"description":"Community id.","schema":{"type":"string"},"x-aliases":["community_id"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Community_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"twitter.community","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"x","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"A public X community: name, description, banner, member count, creation date, creator, join policy, rules and a few member handles (`extra`). Unknown communities answer not_found.","x-one-of":[["url","id"]],"x-examples":[{"id":"1926186499399139650"}]}},"/v1/twitter/community/tweets":{"get":{"operationId":"twitter.community.tweets","summary":"X community posts","tags":["twitter"],"parameters":[{"name":"url","in":"query","required":false,"description":"Community URL (x.com/i/communities/<id>).","schema":{"type":"string","format":"uri"},"x-hosts":["x.com","twitter.com"]},{"name":"id","in":"query","required":false,"description":"Community id.","schema":{"type":"string"},"x-aliases":["community_id"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"twitter.community.tweets","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"x","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"The 20 most-liked posts of a public X community, which is all X shows. X offers no way to page further, so there is no next-page cursor and newer posts are not reachable. The community itself is returned as `parent`.","x-one-of":[["url","id"]],"x-examples":[{"id":"1926186499399139650"}]}},"/v1/facebook/profile":{"get":{"operationId":"facebook.profile","summary":"Facebook profile or page","tags":["facebook"],"parameters":[{"name":"url","in":"query","required":true,"description":"Profile or page URL.","schema":{"type":"string","format":"uri"},"x-hosts":["facebook.com","fb.com","fb.watch"]},{"name":"get_business_hours","in":"query","required":false,"description":"Include the business hours.","schema":{"type":"boolean","default":false}},{"name":"include_gated_profile","in":"query","required":false,"description":"Return limited public fields for gated or age-restricted pages. Ignored for normal public pages.","schema":{"type":"boolean","default":false}},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Profile_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"facebook.profile","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"facebook","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"A public page: category, address, email, phone, website, services, price range, rating, likes and followers (`talking_about` only when Facebook shows it), plus its ad library page id.","x-examples":[{"url":"https://www.facebook.com/nasa"}]}},"/v1/facebook/profile/posts":{"get":{"operationId":"facebook.profile.posts","summary":"Facebook profile posts","tags":["facebook"],"parameters":[{"name":"url","in":"query","required":false,"description":"Profile or page URL.","schema":{"type":"string","format":"uri"},"x-hosts":["facebook.com","fb.com","fb.watch"]},{"name":"id","in":"query","required":false,"description":"The profile or page id, as `profile` returns it in `id`.","schema":{"type":"string"},"x-aliases":["pageId","page_id"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"facebook.profile.posts","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"facebook","x-mode":"sync","x-timeout-seconds":60,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Public posts of a page, 3 a page: text, reactions, comments, time, video URLs and top comments.","x-one-of":[["url","id"]],"x-examples":[{"url":"https://www.facebook.com/nasa"}]}},"/v1/facebook/profile/reels":{"get":{"operationId":"facebook.profile.reels","summary":"Facebook profile reels","tags":["facebook"],"parameters":[{"name":"url","in":"query","required":true,"description":"Profile or page URL.","schema":{"type":"string","format":"uri"},"x-hosts":["facebook.com","fb.com","fb.watch"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"facebook.profile.reels","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"facebook","x-mode":"sync","x-timeout-seconds":60,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Up to 10 reels a page: id, URL, view count (Facebook's rounded public badge, so 27K becomes 27000), description, time, video URL, duration and music. For exact counts, call `post` per reel.","x-examples":[{"url":"https://www.facebook.com/nike"}]}},"/v1/facebook/profile/photos":{"get":{"operationId":"facebook.profile.photos","summary":"Facebook profile photos","tags":["facebook"],"parameters":[{"name":"url","in":"query","required":true,"description":"Profile or page URL.","schema":{"type":"string","format":"uri"},"x-hosts":["facebook.com","fb.com","fb.watch"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"facebook.profile.photos","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"facebook","x-mode":"sync","x-timeout-seconds":60,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Photos from a page's Photos tab (type \"image\"): id, caption, image URL and size. The cursor carries both of ScrapeCreators' paging values (`next_page_id` and `cursor`).","x-examples":[{"url":"https://www.facebook.com/nasa"}]}},"/v1/facebook/profile/events":{"get":{"operationId":"facebook.profile.events","summary":"Facebook page events","tags":["facebook"],"parameters":[{"name":"url","in":"query","required":true,"description":"Profile or page URL.","schema":{"type":"string","format":"uri"},"x-hosts":["facebook.com","fb.com","fb.watch"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Event__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"facebook.profile.events","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"facebook","x-mode":"sync","x-timeout-seconds":60,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Public events of a page.","x-examples":[{"url":"https://www.facebook.com/brickyardoldtown"}]}},"/v1/facebook/search/videos":{"get":{"operationId":"facebook.search.videos","summary":"Facebook video search","tags":["facebook"],"parameters":[{"name":"query","in":"query","required":true,"description":"Search terms.","schema":{"type":"string"},"x-aliases":["keyword","q"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"facebook.search.videos","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"facebook","x-mode":"sync","x-timeout-seconds":60,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Facebook's own video search: matching videos and reels in Facebook's ranking. Not exhaustive; can take several seconds. Keep the query unchanged while paging.","x-examples":[{"query":"nasa"}]}},"/v1/facebook/post":{"get":{"operationId":"facebook.post","summary":"Facebook post details","tags":["facebook"],"parameters":[{"name":"url","in":"query","required":true,"description":"Post, video or reel URL.","schema":{"type":"string","format":"uri"},"x-hosts":["facebook.com","fb.com","fb.watch"]},{"name":"get_transcript","in":"query","required":false,"description":"Include the video's existing captions in `extra.transcript` (none if it has none; `post/transcript` also transcribes the audio with AI).","schema":{"type":"boolean","default":false}},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Post_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"facebook.post","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"facebook","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"One public post or reel: text, counts, reactions, media and the `feedback_id` that makes `post/comments` faster. Call it per reel for exact like, comment and view counts (Facebook shows no share count on a video page; `profile/posts` has it).","x-examples":[{"url":"https://www.facebook.com/reel/2166091230582141/"}]}},"/v1/facebook/post/transcript":{"get":{"operationId":"facebook.post.transcript","summary":"Facebook video transcript","tags":["facebook"],"parameters":[{"name":"url","in":"query","required":true,"description":"Post, video or reel URL.","schema":{"type":"string","format":"uri"},"x-hosts":["facebook.com","fb.com","fb.watch"]},{"name":"allow_long_transcription","in":"query","required":false,"description":"Transcribe audio past 2 minutes with AI, at 5 credits per started minute of the whole video. Without it a longer video answers transcript_unavailable, which is free.","schema":{"type":"boolean","default":false},"x-aliases":["allowLongTranscription"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit for captions; AI transcription 1 up to 2 minutes, then 5 per started minute of the whole video.","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Transcript_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"facebook.post.transcript","x-credits":"transcript","x-credit-rule":"1 credit for captions; AI transcription 1 up to 2 minutes, then 5 per started minute of the whole video","x-status":"ga","x-pool":"facebook","x-mode":"sync","x-timeout-seconds":180,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Transcript of a video post or reel: existing captions first, otherwise AI transcription of the audio.","x-examples":[{"url":"https://www.facebook.com/reel/1535656380759655"}]}},"/v1/facebook/post/comments":{"get":{"operationId":"facebook.post.comments","summary":"Facebook post comments","tags":["facebook"],"parameters":[{"name":"url","in":"query","required":false,"description":"Post, video or reel URL.","schema":{"type":"string","format":"uri"},"x-hosts":["facebook.com","fb.com","fb.watch"]},{"name":"feedback_id","in":"query","required":false,"description":"The post's feedback id (from `post`); using it instead of `url` makes the request much faster.","schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Comment__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"facebook.post.comments","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"facebook","x-mode":"sync","x-timeout-seconds":60,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Comments on a post or reel: text, time, reply and reaction counts, author and attachments.","x-one-of":[["feedback_id","url"]],"x-examples":[{"url":"https://www.facebook.com/reel/2166091230582141/"}]}},"/v1/facebook/post/comment/replies":{"get":{"operationId":"facebook.post.comment.replies","summary":"Facebook comment replies","tags":["facebook"],"parameters":[{"name":"url","in":"query","required":false,"description":"Post, video or reel URL.","schema":{"type":"string","format":"uri"},"x-hosts":["facebook.com","fb.com","fb.watch"]},{"name":"comment_id","in":"query","required":false,"description":"Id of the parent comment.","schema":{"type":"string"},"x-aliases":["commentId"]},{"name":"feedback_id","in":"query","required":false,"description":"The comment's feedback id (not the comment id), from `post/comments`.","schema":{"type":"string"}},{"name":"expansion_token","in":"query","required":false,"description":"The comment's expansion token, from `post/comments`.","schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Comment__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"facebook.post.comment.replies","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"facebook","x-mode":"sync","x-timeout-seconds":90,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Replies to one comment. Either the post `url` and the parent `comment_id`, or the comment's `feedback_id` and `expansion_token` as the comments list returns them (both are needed).","x-one-of":[["feedback_id","url"]],"x-examples":[{"url":"https://www.facebook.com/reel/2166091230582141/","comment_id":"2082653245809386"}]}},"/v1/facebook/group":{"get":{"operationId":"facebook.group","summary":"Facebook public group","tags":["facebook"],"parameters":[{"name":"url","in":"query","required":false,"description":"Public group URL (facebook.com/groups/...). Sub-pages such as /about work too.","schema":{"type":"string","format":"uri"},"x-hosts":["facebook.com","fb.com","fb.watch"]},{"name":"id","in":"query","required":false,"description":"Numeric group id; use it instead of `url` if you have it.","schema":{"type":"string"},"x-aliases":["group_id"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Community_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"facebook.group","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"facebook","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"What a public group's About page shows: description, privacy, member and activity counts, categories, admins and moderators where shown, history and rules.","x-one-of":[["url","id"]],"x-examples":[{"url":"https://www.facebook.com/groups/366190054572553"}]}},"/v1/facebook/group/posts":{"get":{"operationId":"facebook.group.posts","summary":"Facebook public group posts","tags":["facebook"],"parameters":[{"name":"url","in":"query","required":false,"description":"Public group URL (facebook.com/groups/...). Sub-pages such as /about work too.","schema":{"type":"string","format":"uri"},"x-hosts":["facebook.com","fb.com","fb.watch"]},{"name":"id","in":"query","required":false,"description":"Numeric group id; use it instead of `url` if you have it.","schema":{"type":"string"},"x-aliases":["group_id"]},{"name":"sort","in":"query","required":false,"description":"Order of results. Changing it restarts the cursor chain.","schema":{"type":"string","enum":["chronological","top","recent_activity","chronological_listings"],"default":"chronological"},"x-aliases":["sort_by","sortBy","order"],"x-value-aliases":{"TOP_POSTS":"top","RECENT_ACTIVITY":"recent_activity","CHRONOLOGICAL":"chronological","CHRONOLOGICAL_LISTINGS":"chronological_listings"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"facebook.group.posts","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"facebook","x-mode":"sync","x-timeout-seconds":60,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Posts of a public group, 3 a page, chronological by default.","x-one-of":[["url","id"]],"x-examples":[{"url":"https://www.facebook.com/groups/366190054572553"}]}},"/v1/facebook/marketplace/location/search":{"get":{"operationId":"facebook.marketplace.location.search","summary":"Facebook Marketplace location search","tags":["facebook"],"parameters":[{"name":"query","in":"query","required":true,"description":"City or area name.","schema":{"type":"string"},"x-aliases":["keyword","q"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Location__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"facebook.marketplace.location.search","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"facebook","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Marketplace cities and areas matching a name, with the coordinates to pass to `marketplace/search` as `lat` and `lng`.","x-examples":[{"query":"Austin"}]}},"/v1/facebook/marketplace/search":{"get":{"operationId":"facebook.marketplace.search","summary":"Facebook Marketplace search","tags":["facebook"],"parameters":[{"name":"query","in":"query","required":false,"description":"Search keyword. Required unless `category_id` is given.","schema":{"type":"string"},"x-aliases":["keyword","q"]},{"name":"location","in":"query","required":false,"description":"City or area to search around (\"Austin, TX\").","schema":{"type":"string"}},{"name":"lat","in":"query","required":false,"description":"Latitude of the search centre.","schema":{"type":"number"},"x-aliases":["latitude"]},{"name":"lng","in":"query","required":false,"description":"Longitude of the search centre.","schema":{"type":"number"},"x-aliases":["longitude"]},{"name":"category_id","in":"query","required":false,"description":"Marketplace category id. Without a keyword only these browse: Antiques 393860164117441, Appliances 678754142233400, Bicycles 1658310421102081, Boats 712638205822882, Electronics 1792291877663080, Furniture 1583634935226685, Garden 800089866739547, Household 1569171756675761, Tools 1670493229902393, Trailers 655837954899686, Vehicles 807311116002614 (or 546583916084032). Other ids need a keyword.","schema":{"type":"string"}},{"name":"radius_km","in":"query","required":false,"description":"Search radius in km.","schema":{"type":"number"},"x-aliases":["radius"]},{"name":"min_price","in":"query","required":false,"description":"Lowest listing price.","schema":{"type":"number"}},{"name":"max_price","in":"query","required":false,"description":"Highest listing price.","schema":{"type":"number"}},{"name":"sort","in":"query","required":false,"description":"Order of results. Changing it restarts the cursor chain.","schema":{"type":"string","enum":["relevance","distance","newest","price_low","price_high"]},"x-aliases":["sort_by","sortBy","order"],"x-value-aliases":{"suggested":"relevance","distance_ascend":"distance","creation_time_descend":"newest","price_ascend":"price_low","price_descend":"price_high"}},{"name":"delivery_method","in":"query","required":false,"description":"Delivery filter.","schema":{"type":"string","enum":["all","local_pickup","shipping"]}},{"name":"condition","in":"query","required":false,"description":"Condition filter.","schema":{"type":"string","enum":["new","used_like_new","used_good","used_fair"]}},{"name":"date_listed","in":"query","required":false,"description":"Listed within. Uses the UI's calendar-day buckets.","schema":{"type":"string","enum":["all","day","week","month"]},"x-value-aliases":{"1":"day","7":"week","30":"month","last_24_hours":"day","last_7_days":"week","last_30_days":"month"}},{"name":"availability","in":"query","required":false,"description":"Availability filter.","schema":{"type":"string","enum":["available","sold","all"]}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Product__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"facebook.marketplace.search","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"facebook","x-mode":"sync","x-timeout-seconds":60,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Search Marketplace by keyword, or browse a category without a keyword. Needs a place: `lat` and `lng` (see `marketplace/location/search`) or a `location` name. About 24 listings a page; keep the inputs unchanged while paging and de-duplicate by listing id.","x-one-of":[["lat","location"]],"x-examples":[{"query":"bike","location":"Austin, TX"}]}},"/v1/facebook/marketplace/item":{"get":{"operationId":"facebook.marketplace.item","summary":"Facebook Marketplace listing","tags":["facebook"],"parameters":[{"name":"url","in":"query","required":false,"description":"Listing URL (facebook.com/marketplace/item/<id>).","schema":{"type":"string","format":"uri"},"x-hosts":["facebook.com","fb.com","fb.watch"]},{"name":"id","in":"query","required":false,"description":"Listing id.","schema":{"type":"string"},"x-aliases":["item_id"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Product_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"facebook.marketplace.item","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"facebook","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"One listing: title, description, price, location, condition, photos, seller and availability flags.","x-one-of":[["url","id"]],"x-examples":[{"id":"1114608241188932"}]}},"/v1/facebook/events/search":{"get":{"operationId":"facebook.events.search","summary":"Facebook Events search","tags":["facebook"],"parameters":[{"name":"query","in":"query","required":true,"description":"Search terms.","schema":{"type":"string"},"x-aliases":["keyword","q"]},{"name":"location","in":"query","required":false,"description":"City or area to search around (\"Austin, TX\").","schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Event__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"facebook.events.search","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"facebook","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Events matching a name or description, as facebook.com/events/search shows them (about 7 on the first page). There is no place filter: `location` is searched as words after the query.","x-examples":[{"query":"jazz","location":"Austin"}]}},"/v1/facebook/events":{"get":{"operationId":"facebook.events","summary":"Facebook city events","tags":["facebook"],"parameters":[{"name":"url","in":"query","required":true,"description":"City events page (facebook.com/events/explore/<city>/<id>).","schema":{"type":"string","format":"uri"},"x-hosts":["facebook.com","fb.com","fb.watch"]},{"name":"time","in":"query","required":false,"description":"Time frame; default all time.","schema":{"type":"string","enum":["today","this_week","next_week"]}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Event__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"facebook.events","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"facebook","x-mode":"sync","x-timeout-seconds":60,"x-cache":{"cacheable":true,"ttl_days":30},"description":"The events Facebook lists for a city, from its public explore page.","x-examples":[{"url":"https://www.facebook.com/events/explore/saint-petersburg-florida/111326725552547"}]}},"/v1/facebook/event":{"get":{"operationId":"facebook.event","summary":"Facebook event details","tags":["facebook"],"parameters":[{"name":"url","in":"query","required":false,"description":"Event URL (facebook.com/events/<id>).","schema":{"type":"string","format":"uri"},"x-hosts":["facebook.com","fb.com","fb.watch"]},{"name":"id","in":"query","required":false,"description":"Event id.","schema":{"type":"string"},"x-aliases":["event_id"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Event_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"facebook.event","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"facebook","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"x-one-of":[["url","id"]],"x-examples":[{"id":"437638146356948"}],"x-aliases":["/v1/facebook/event/details"]}},"/v1/linkedin/profile":{"get":{"operationId":"linkedin.profile","summary":"LinkedIn public person profile","tags":["linkedin"],"parameters":[{"name":"url","in":"query","required":true,"description":"Profile URL (linkedin.com/in/<slug>).","schema":{"type":"string","format":"uri"},"x-hosts":["linkedin.com"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Profile_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"linkedin.profile","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"linkedin","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"What LinkedIn shows on a profile page: name, headline, location, about, followers, experience, education, skills, courses, recommendations, articles, recent public posts and similar profiles. LinkedIn sometimes turns requests away: those answer `upstream_blocked` (free) and are worth retrying. A member who hides the public profile looks the same as a refused request, so a profile that keeps answering `upstream_blocked` may have no public page.","x-examples":[{"url":"https://www.linkedin.com/in/williamhgates"}]}},"/v1/linkedin/company":{"get":{"operationId":"linkedin.company","summary":"LinkedIn company page","tags":["linkedin"],"parameters":[{"name":"url","in":"query","required":true,"description":"Company page URL (linkedin.com/company/<slug>).","schema":{"type":"string","format":"uri"},"x-hosts":["linkedin.com"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Profile_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"linkedin.company","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"linkedin","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"A company page: description, website, industry, size, headquarters, specialties, locations, followers, employee count, affiliated and similar pages.","x-examples":[{"url":"https://www.linkedin.com/company/microsoft"}]}},"/v1/linkedin/company/posts":{"get":{"operationId":"linkedin.company.posts","summary":"LinkedIn company posts","tags":["linkedin"],"parameters":[{"name":"url","in":"query","required":true,"description":"Company page URL (linkedin.com/company/<slug>).","schema":{"type":"string","format":"uri"},"x-hosts":["linkedin.com"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"linkedin.company.posts","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"linkedin","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"The latest public posts and reposts on a company page (up to 10): URL, id, date, full text, media, reactions and comment counts. LinkedIn shows only this block; the posts tab and later pages need a login, so the cursor is always null.","x-examples":[{"url":"https://www.linkedin.com/company/microsoft"}]}},"/v1/linkedin/search/posts":{"get":{"operationId":"linkedin.search.posts","summary":"LinkedIn post search","tags":["linkedin"],"parameters":[{"name":"query","in":"query","required":true,"description":"Keyword or phrase to look for in public LinkedIn posts.","schema":{"type":"string"},"x-aliases":["keyword","q"]},{"name":"date_posted","in":"query","required":false,"description":"Only posts found in this window.","schema":{"type":"string","enum":["day","week","month","year"]},"x-value-aliases":{"last-hour":"hour","last-day":"day","last-week":"week","last-month":"month","last-year":"year"}},{"name":"enrich","in":"query","required":false,"description":"Read each post for its full text, author, date and counts (on by default). Off returns only what the search result states, much cheaper and faster.","schema":{"type":"boolean","default":true}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"linkedin.search.posts","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"linkedin","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Public LinkedIn posts and Pulse articles that a web search has indexed for a query (DuckDuckGo's results, not Google's), best effort and not a complete search (LinkedIn's own search needs a login). The cursor is the next results page and cannot go past 11. Each result is read like `linkedin/post` for the full text, author, date and counts (`enrich`, on by default; a post LinkedIn no longer shows is dropped). `date_posted` takes day, week, month or year. When the search provider asks for human verification on every try the call fails and can be retried.","x-examples":[{"query":"ai agents"}]}},"/v1/linkedin/post":{"get":{"operationId":"linkedin.post","summary":"LinkedIn public post","tags":["linkedin"],"parameters":[{"name":"url","in":"query","required":true,"description":"Post URL (linkedin.com/posts/... or /feed/update/urn:li:activity:...).","schema":{"type":"string","format":"uri"},"x-hosts":["linkedin.com"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Post_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"linkedin.post","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"linkedin","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"A public post: full text, author, date, reactions and comment counts, media (video, images, shared article) and the top public comments. Also reads /feed/update/urn:li:activity:... and Pulse (/pulse/...) article URLs.","x-examples":[{"url":"https://www.linkedin.com/posts/jeffweiner08_seeing-lots-of-content-about-dolly-parton-activity-7499148115615350784-j-4g"}]}},"/v1/linkedin/post/transcript":{"get":{"operationId":"linkedin.post.transcript","summary":"LinkedIn post video transcript","tags":["linkedin"],"parameters":[{"name":"url","in":"query","required":true,"description":"Post URL (linkedin.com/posts/...).","schema":{"type":"string","format":"uri"},"x-hosts":["linkedin.com"]},{"name":"allow_long_transcription","in":"query","required":false,"description":"Transcribe audio past 2 minutes with AI, at 5 credits per started minute of the whole video. Without it a longer video answers transcript_unavailable, which is free.","schema":{"type":"boolean","default":false},"x-aliases":["allowLongTranscription"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit for captions; AI transcription 1 up to 2 minutes, then 5 per started minute of the whole video.","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Transcript_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"linkedin.post.transcript","x-credits":"transcript","x-credit-rule":"1 credit for captions; AI transcription 1 up to 2 minutes, then 5 per started minute of the whole video","x-status":"ga","x-pool":"linkedin","x-mode":"sync","x-timeout-seconds":180,"x-cache":{"cacheable":true,"ttl_days":30},"description":"The transcript of a post's video when LinkedIn shows one; otherwise AI transcription of the video's audio.","x-examples":[{"url":"https://www.linkedin.com/feed/update/urn:li:activity:7520503284458147840"}]}},"/v1/tiktok/shop/search":{"get":{"operationId":"tiktok.shop.search","summary":"TikTok Shop product search","tags":["tiktok"],"parameters":[{"name":"query","in":"query","required":true,"description":"Search terms.","schema":{"type":"string"},"x-aliases":["keyword","q"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"region","in":"query","required":false,"description":"Two-letter country code (ISO 3166-1) for results that vary by country.","schema":{"type":"string"},"example":"US","x-aliases":["country","geo"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Product__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"tiktok.shop.search","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"commerce","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Products matching a search, each with price, rating, sold count and shop. Pages of 20 by cursor; TikTok decides how deep a query goes (past 40 results when it has them). US catalogue only.","x-examples":[{"query":"phone case","region":"US"}]}},"/v1/tiktok/shop/products":{"get":{"operationId":"tiktok.shop.products","summary":"TikTok Shop products of a shop","tags":["tiktok"],"parameters":[{"name":"url","in":"query","required":true,"description":"Shop URL (tiktok.com/shop/store/<name>/<id>).","schema":{"type":"string","format":"uri"},"x-hosts":["tiktok.com"]},{"name":"sort","in":"query","required":false,"description":"Order of results. Changing it restarts the cursor chain.","schema":{"type":"string","enum":["top","new_releases"],"default":"top"},"x-aliases":["sort_by","sortBy","order"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"region","in":"query","required":false,"description":"Two-letter country code (ISO 3166-1) for results that vary by country.","schema":{"type":"string"},"example":"US","x-aliases":["country","geo"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Product__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"tiktok.shop.products","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"commerce","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Every product of one shop; `parent` is the shop's profile (first page). 20 products a page in TikTok's own order, which puts a shop's best sellers first. `sort=new_releases` reads the whole catalogue (up to 120 products) and orders it newest first by product id, so it ignores the cursor and returns one page. US catalogue only.","x-examples":[{"url":"https://www.tiktok.com/shop/store/goli-nutrition/7495794203056835079"}]}},"/v1/tiktok/shop/showcase":{"get":{"operationId":"tiktok.shop.showcase","summary":"TikTok creator showcase products","tags":["tiktok"],"parameters":[{"name":"handle","in":"query","required":true,"description":"Username, with or without the leading @.","schema":{"type":"string"},"x-aliases":["username"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"region","in":"query","required":false,"description":"Two-letter country code (ISO 3166-1) for results that vary by country.","schema":{"type":"string"},"example":"US","x-aliases":["country","geo"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Product__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"tiktok.shop.showcase","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"stub","x-pool":"commerce","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Products a creator features in their public showcase; `parent` is the creator's profile. Not available yet: TikTok serves showcases only through a signed request its pages do not carry, so this answers 501 until the signing service exists.","x-examples":[{"handle":"mrtiktokreviews"}],"x-aliases":["/v1/tiktok/user/showcase"]}},"/v1/tiktok/shop/product":{"get":{"operationId":"tiktok.shop.product","summary":"TikTok Shop product details","tags":["tiktok"],"parameters":[{"name":"url","in":"query","required":false,"description":"Product URL (tiktok.com/shop/pdp/...).","schema":{"type":"string","format":"uri"},"x-hosts":["tiktok.com"]},{"name":"id","in":"query","required":false,"description":"Product id.","schema":{"type":"string"},"x-aliases":["product_id"]},{"name":"region","in":"query","required":false,"description":"Two-letter country code (ISO 3166-1) for results that vary by country.","schema":{"type":"string"},"example":"US","x-aliases":["country","geo"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Product_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"tiktok.shop.product","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"commerce","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"One product with its SKUs and stock levels (in `extra`), rating, rating spread, specifications and shipping. US catalogue only. TikTok sometimes treats an exit as a crawler; the request is retried on fresh exits and answers `upstream_blocked` (free) if all three are refused.","x-one-of":[["url","id"]],"x-examples":[{"id":"1729527313880355335"}],"x-aliases":["/v1/tiktok/product"]}},"/v1/tiktok/shop/product/reviews":{"get":{"operationId":"tiktok.shop.product.reviews","summary":"TikTok Shop product reviews","tags":["tiktok"],"parameters":[{"name":"url","in":"query","required":false,"description":"Product URL (tiktok.com/shop/pdp/...).","schema":{"type":"string","format":"uri"},"x-hosts":["tiktok.com"]},{"name":"id","in":"query","required":false,"description":"Product id.","schema":{"type":"string"},"x-aliases":["product_id"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"region","in":"query","required":false,"description":"Two-letter country code (ISO 3166-1) for results that vary by country.","schema":{"type":"string"},"example":"US","x-aliases":["country","geo"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Review__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"tiktok.shop.product.reviews","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"commerce","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Customer reviews of a product, newest first: rating, text, photos, the reviewer's masked name and the variant bought. 5 a page. The first page is always available; later pages depend on TikTok accepting the exit and answer `upstream_blocked` (free) when it does not.","x-one-of":[["url","id"]],"x-examples":[{"id":"1729527313880355335"}]}},"/v1/amazon/shop":{"get":{"operationId":"amazon.shop","summary":"Amazon storefront products","tags":["amazon"],"parameters":[{"name":"url","in":"query","required":true,"description":"Storefront URL (amazon.com/shop/<name>).","schema":{"type":"string","format":"uri"},"x-hosts":["amazon.com","amazon.co.uk","amazon.ca","amazon.de","amazon.fr","amazon.com.au","amzn.to"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Product__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"amazon.shop","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"commerce","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Products featured on an Amazon creator storefront, each ASIN once, with the lists, photos and videos that feature it in `extra.posts`. The first page also carries the creator's trending picks (with prices) and `parent`: the creator's profile with socials, curations and lists. 20 posts a page. Creator storefronts only (amazon.com/shop/<name>); brand stores (amazon.com/stores/...) are not supported. The creator's affiliate tags are removed from every URL.","x-examples":[{"url":"https://www.amazon.com/shop/sydneydelrey"}]}},"/v1/spotify/artist":{"get":{"operationId":"spotify.artist","summary":"Spotify artist","tags":["spotify"],"parameters":[{"name":"url","in":"query","required":false,"description":"Spotify artist URL.","schema":{"type":"string","format":"uri"},"x-hosts":["open.spotify.com","spotify.com","spotify.link"]},{"name":"id","in":"query","required":false,"description":"Spotify artist id.","schema":{"type":"string"}},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Profile_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"spotify.artist","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Followers, monthly listeners, world rank, top cities, bio, links, top tracks, albums, singles, related artists and playlists (in `extra`). Spotify has no handles: `id` is the 22 character id.","x-one-of":[["url","id"]],"x-examples":[{"url":"https://open.spotify.com/artist/06HL4z0CvFAxyc27GXpf02"}]}},"/v1/spotify/album":{"get":{"operationId":"spotify.album","summary":"Spotify album","tags":["spotify"],"parameters":[{"name":"url","in":"query","required":false,"description":"Spotify album URL.","schema":{"type":"string","format":"uri"},"x-hosts":["open.spotify.com","spotify.com","spotify.link"]},{"name":"id","in":"query","required":false,"description":"Spotify album id.","schema":{"type":"string"}},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Album_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"spotify.album","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"The album with its tracks (up to 200), label, copyright and release date.","x-one-of":[["url","id"]],"x-examples":[{"id":"5AEDGbliTTfjOB8TSm1sxt"}]}},"/v1/spotify/track":{"get":{"operationId":"spotify.track","summary":"Spotify track","tags":["spotify"],"parameters":[{"name":"url","in":"query","required":false,"description":"Spotify track URL.","schema":{"type":"string","format":"uri"},"x-hosts":["open.spotify.com","spotify.com","spotify.link"]},{"name":"id","in":"query","required":false,"description":"Spotify track id.","schema":{"type":"string"}},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Song_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"spotify.track","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Title, artists, album, duration, lifetime play count and the 30 second preview URL.","x-one-of":[["url","id"]],"x-examples":[{"id":"4cOdK2wGLETKBW3PvgPWqT"}]}},"/v1/spotify/podcast":{"get":{"operationId":"spotify.podcast","summary":"Spotify podcast","tags":["spotify"],"parameters":[{"name":"url","in":"query","required":false,"description":"Spotify show URL.","schema":{"type":"string","format":"uri"},"x-hosts":["open.spotify.com","spotify.com","spotify.link"]},{"name":"id","in":"query","required":false,"description":"Spotify show id.","schema":{"type":"string"}},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Collection_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"spotify.podcast","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"A show's details (kind \"podcast\").","x-one-of":[["url","id"]],"x-examples":[{"id":"4rOoJ6Egrf8K2IrywzwOMk"}]}},"/v1/spotify/playlist":{"get":{"operationId":"spotify.playlist","summary":"Spotify playlist","tags":["spotify"],"parameters":[{"name":"url","in":"query","required":false,"description":"Spotify playlist URL.","schema":{"type":"string","format":"uri"},"x-hosts":["open.spotify.com","spotify.com","spotify.link"]},{"name":"id","in":"query","required":false,"description":"Spotify playlist id.","schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Song__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"spotify.playlist","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"A public playlist's tracks, 50 a page; `parent` is the playlist. Pass the cursor back until it is null.","x-one-of":[["url","id"]],"x-examples":[{"id":"37i9dQZF1DX4UtSsGT1Sbe"}]}},"/v1/spotify/podcast/episodes":{"get":{"operationId":"spotify.podcast.episodes","summary":"Spotify podcast episodes","tags":["spotify"],"parameters":[{"name":"url","in":"query","required":false,"description":"Spotify show URL.","schema":{"type":"string","format":"uri"},"x-hosts":["open.spotify.com","spotify.com","spotify.link"]},{"name":"id","in":"query","required":false,"description":"Spotify show id.","schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"spotify.podcast.episodes","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"A show's episodes, 20 a page, in the order Spotify lists them (type \"episode\"); `parent` is the show. Pass the cursor back until it is null.","x-one-of":[["url","id"]],"x-examples":[{"id":"4rOoJ6Egrf8K2IrywzwOMk"}]}},"/v1/spotify/search":{"get":{"operationId":"spotify.search","summary":"Spotify search","tags":["spotify"],"parameters":[{"name":"query","in":"query","required":true,"description":"Search terms.","schema":{"type":"string"},"x-aliases":["keyword","q"]},{"name":"type","in":"query","required":false,"description":"Kind of result.","schema":{"type":"string","enum":["track","album","artist","playlist","show","episode","audiobook"]},"x-value-aliases":{"podcast":"show","podcasts":"show","tracks":"track","albums":"album","artists":"artist","playlists":"playlist","episodes":"episode","audiobooks":"audiobook"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"region","in":"query","required":false,"description":"Two-letter country code (ISO 3166-1) for results that vary by country.","schema":{"type":"string"},"example":"US","x-aliases":["country","geo"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Annotated_Union_Song__Album__Profile__Collection___FieldInfo_annotation_NoneType__required_True__discriminator__object_____"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"spotify.search","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Tracks, artists, albums, playlists, podcasts, episodes and audiobooks. Without `type` every kind is returned, 10 of each; with `type`, 20 of that kind. Use `type=show` to find podcast ids. Episodes come back as songs with `extra.type` \"episode\", audiobooks as collections. Results follow the country of the server's IP; `region` is accepted but does not change them.","x-examples":[{"query":"taylor swift"}]}},"/v1/apple-music/artist":{"get":{"operationId":"apple_music.artist","summary":"Apple Music artist","tags":["apple_music"],"parameters":[{"name":"url","in":"query","required":false,"description":"Apple Music artist URL.","schema":{"type":"string","format":"uri"},"x-hosts":["music.apple.com"]},{"name":"id","in":"query","required":false,"description":"Apple Music artist id.","schema":{"type":"string"}},{"name":"region","in":"query","required":false,"description":"Two-letter country code (ISO 3166-1) for results that vary by country.","schema":{"type":"string"},"example":"US","x-aliases":["country","geo"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Profile_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"apple_music.artist","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Bio, origin, genres, top songs and albums. Apple Music shows no follower or listener counts, so `stats` is empty. `region` is the storefront (default us); a URL carries its own.","x-one-of":[["url","id"]],"x-examples":[{"url":"https://music.apple.com/us/artist/taylor-swift/159260351"}]}},"/v1/apple-music/album":{"get":{"operationId":"apple_music.album","summary":"Apple Music album","tags":["apple_music"],"parameters":[{"name":"url","in":"query","required":false,"description":"Apple Music album URL.","schema":{"type":"string","format":"uri"},"x-hosts":["music.apple.com"]},{"name":"id","in":"query","required":false,"description":"Apple Music album id.","schema":{"type":"string"}},{"name":"region","in":"query","required":false,"description":"Two-letter country code (ISO 3166-1) for results that vary by country.","schema":{"type":"string"},"example":"US","x-aliases":["country","geo"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Album_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"apple_music.album","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"The album with its tracks, label, UPC, copyright and editorial notes.","x-one-of":[["url","id"]],"x-examples":[{"id":"1468058165"}]}},"/v1/apple-music/track":{"get":{"operationId":"apple_music.track","summary":"Apple Music track","tags":["apple_music"],"parameters":[{"name":"url","in":"query","required":false,"description":"Apple Music song URL.","schema":{"type":"string","format":"uri"},"x-hosts":["music.apple.com"]},{"name":"id","in":"query","required":false,"description":"Apple Music song id.","schema":{"type":"string"}},{"name":"region","in":"query","required":false,"description":"Two-letter country code (ISO 3166-1) for results that vary by country.","schema":{"type":"string"},"example":"US","x-aliases":["country","geo"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Song_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"apple_music.track","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Title, artists, album, duration, ISRC, composer and the 30 second preview. A track link on an album page ends in `?i=<song id>`; that id is the song's.","x-one-of":[["url","id"]],"x-examples":[{"id":"1468058169"}]}},"/v1/apple-music/search":{"get":{"operationId":"apple_music.search","summary":"Apple Music search","tags":["apple_music"],"parameters":[{"name":"query","in":"query","required":true,"description":"Search terms.","schema":{"type":"string"},"x-aliases":["keyword","q"]},{"name":"type","in":"query","required":false,"description":"Kind of result; `all` returns every section.","schema":{"type":"string","enum":["all","song","album","artist","playlist","station","music_video","radio_episode"]}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"region","in":"query","required":false,"description":"Two-letter country code (ISO 3166-1) for results that vary by country.","schema":{"type":"string"},"example":"US","x-aliases":["country","geo"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Annotated_Union_Song__Album__Profile__Collection___FieldInfo_annotation_NoneType__required_True__discriminator__object_____"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"apple_music.search","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Public results for artists, albums, songs, playlists, stations and music videos. Without `type` every section is returned, 8 of each; with `type`, 25 of that kind. Music videos come back as songs with `extra.type` \"music_video\", playlists and stations as collections. `radio_episode` is not offered by Apple's public catalog search and answers invalid_params.","x-examples":[{"query":"taylor swift"}]}},"/v1/soundcloud/artist":{"get":{"operationId":"soundcloud.artist","summary":"SoundCloud artist","tags":["soundcloud"],"parameters":[{"name":"url","in":"query","required":false,"description":"Artist URL (soundcloud.com/<user>).","schema":{"type":"string","format":"uri"},"x-hosts":["soundcloud.com","on.soundcloud.com"]},{"name":"handle","in":"query","required":false,"description":"Username, with or without the leading @.","schema":{"type":"string"},"x-aliases":["username"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Profile_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"soundcloud.artist","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Followers, track count, bio, location, avatar, banner and the social links the artist lists.","x-one-of":[["url","handle"]],"x-examples":[{"handle":"flume"}]}},"/v1/soundcloud/artist/tracks":{"get":{"operationId":"soundcloud.artist.tracks","summary":"SoundCloud artist tracks","tags":["soundcloud"],"parameters":[{"name":"url","in":"query","required":false,"description":"Artist URL (soundcloud.com/<user>).","schema":{"type":"string","format":"uri"},"x-hosts":["soundcloud.com","on.soundcloud.com"]},{"name":"handle","in":"query","required":false,"description":"Username, with or without the leading @.","schema":{"type":"string"},"x-aliases":["username"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Song__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"soundcloud.artist.tracks","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"An artist's public tracks, newest first, up to 20 a page (private or blocked tracks are left out, so a page can be shorter); `parent` is the artist. Pass the cursor back until it is null.","x-one-of":[["url","handle"]],"x-examples":[{"handle":"flume"}]}},"/v1/soundcloud/track":{"get":{"operationId":"soundcloud.track","summary":"SoundCloud track","tags":["soundcloud"],"parameters":[{"name":"url","in":"query","required":true,"description":"Track URL (soundcloud.com/<user>/<track>).","schema":{"type":"string","format":"uri"},"x-hosts":["soundcloud.com","on.soundcloud.com"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Song_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"soundcloud.track","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Title, artist, duration, play, like and comment counts, genre, license, ISRC and release date.","x-examples":[{"url":"https://soundcloud.com/flume/all-of-the-worlds"}]}},"/v1/github/user":{"get":{"operationId":"github.user","summary":"GitHub user","tags":["github"],"parameters":[{"name":"handle","in":"query","required":false,"description":"GitHub username.","schema":{"type":"string"},"x-aliases":["username","login"]},{"name":"url","in":"query","required":false,"description":"Profile URL (github.com/<user>).","schema":{"type":"string","format":"uri"},"x-hosts":["github.com"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Profile_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"github.user","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"x-one-of":[["handle","url"]],"x-examples":[{"handle":"torvalds"}]}},"/v1/github/user/repositories":{"get":{"operationId":"github.user.repositories","summary":"GitHub user repositories","tags":["github"],"parameters":[{"name":"handle","in":"query","required":false,"description":"GitHub username.","schema":{"type":"string"},"x-aliases":["username","login"]},{"name":"url","in":"query","required":false,"description":"Profile URL (github.com/<user>).","schema":{"type":"string","format":"uri"},"x-hosts":["github.com"]},{"name":"type","in":"query","required":false,"description":"Repository type.","schema":{"type":"string","enum":["owner","all","member"],"default":"owner"}},{"name":"sort","in":"query","required":false,"description":"Order of results. Changing it restarts the cursor chain.","schema":{"type":"string","enum":["updated","created","pushed","full_name"],"default":"updated"},"x-aliases":["sort_by","sortBy","order"]},{"name":"direction","in":"query","required":false,"description":"Sort direction.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Repo__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"github.user.repositories","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"A user's public repositories with description, language, stars, forks, topics, license and dates, 30 a page. `type` and `direction` pass straight through to GitHub.","x-one-of":[["handle","url"]],"x-examples":[{"handle":"torvalds"}]}},"/v1/github/repository":{"get":{"operationId":"github.repository","summary":"GitHub repository","tags":["github"],"parameters":[{"name":"url","in":"query","required":false,"description":"Repository URL (github.com/<owner>/<repo>).","schema":{"type":"string","format":"uri"},"x-hosts":["github.com"]},{"name":"repo","in":"query","required":false,"description":"\"owner/name\".","schema":{"type":"string"},"x-aliases":["full_name"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Repo_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"github.repository","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"x-one-of":[["url","repo"]],"x-examples":[{"repo":"torvalds/linux"}]}},"/v1/github/user/followers":{"get":{"operationId":"github.user.followers","summary":"GitHub followers","tags":["github"],"parameters":[{"name":"handle","in":"query","required":false,"description":"GitHub username.","schema":{"type":"string"},"x-aliases":["username","login"]},{"name":"url","in":"query","required":false,"description":"Profile URL (github.com/<user>).","schema":{"type":"string","format":"uri"},"x-hosts":["github.com"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Profile__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"github.user.followers","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"x-one-of":[["handle","url"]],"x-examples":[{"handle":"torvalds"}]}},"/v1/github/user/following":{"get":{"operationId":"github.user.following","summary":"GitHub following","tags":["github"],"parameters":[{"name":"handle","in":"query","required":false,"description":"GitHub username.","schema":{"type":"string"},"x-aliases":["username","login"]},{"name":"url","in":"query","required":false,"description":"Profile URL (github.com/<user>).","schema":{"type":"string","format":"uri"},"x-hosts":["github.com"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Profile__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"github.user.following","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"x-one-of":[["handle","url"]],"x-examples":[{"handle":"kentcdodds"}]}},"/v1/github/user/contributions":{"get":{"operationId":"github.user.contributions","summary":"GitHub contribution calendar","tags":["github"],"parameters":[{"name":"handle","in":"query","required":false,"description":"GitHub username.","schema":{"type":"string"},"x-aliases":["username","login"]},{"name":"url","in":"query","required":false,"description":"Profile URL (github.com/<user>).","schema":{"type":"string","format":"uri"},"x-hosts":["github.com"]},{"name":"year","in":"query","required":false,"description":"Calendar year (2008 onward); default the current year.","schema":{"type":"integer","minimum":2008,"maximum":2100},"example":2025},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Contributions_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"github.user.contributions","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"The public contribution graph for one year: the total and a count per day.","x-one-of":[["handle","url"]],"x-examples":[{"handle":"torvalds"}]}},"/v1/github/user/activity":{"get":{"operationId":"github.user.activity","summary":"GitHub public activity","tags":["github"],"parameters":[{"name":"handle","in":"query","required":false,"description":"GitHub username.","schema":{"type":"string"},"x-aliases":["username","login"]},{"name":"url","in":"query","required":false,"description":"Profile URL (github.com/<user>).","schema":{"type":"string","format":"uri"},"x-hosts":["github.com"]},{"name":"year","in":"query","required":false,"description":"Calendar year (2008 onward); default the current year.","schema":{"type":"integer","minimum":2008,"maximum":2100},"example":2025},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Activity__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"github.user.activity","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"The profile's contribution activity timeline (commits, repositories created, pull requests, issues, reviews), one month a page, newest month first, paging backward through the year.","x-one-of":[["handle","url"]],"x-examples":[{"handle":"torvalds"}]}},"/v1/github/user/pull-requests":{"get":{"operationId":"github.user.pull_requests","summary":"GitHub pull requests by a user","tags":["github"],"parameters":[{"name":"handle","in":"query","required":false,"description":"GitHub username.","schema":{"type":"string"},"x-aliases":["username","login"]},{"name":"url","in":"query","required":false,"description":"Profile URL (github.com/<user>).","schema":{"type":"string","format":"uri"},"x-hosts":["github.com"]},{"name":"state","in":"query","required":false,"description":"PR state.","schema":{"type":"string","enum":["open","closed","merged","all"],"default":"all"}},{"name":"since","in":"query","required":false,"description":"Only pull requests created on or after this date (YYYY-MM-DD).","schema":{"type":"string"}},{"name":"until","in":"query","required":false,"description":"Only pull requests created on or before this date (YYYY-MM-DD).","schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_PullRequest__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"github.user.pull_requests","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Public pull requests the user authored, newest first, from GitHub's public search index, which serves at most the first 1,000 results of any search.","x-one-of":[["handle","url"]],"x-examples":[{"handle":"torvalds"}]}},"/v1/github/trending/repositories":{"get":{"operationId":"github.trending.repositories","summary":"GitHub trending repositories","tags":["github"],"parameters":[{"name":"language","in":"query","required":false,"description":"Coding language, e.g. javascript, python, go.","schema":{"type":"string"}},{"name":"since","in":"query","required":false,"description":"Trending range.","schema":{"type":"string","enum":["daily","weekly","monthly"],"default":"daily"}},{"name":"spoken_language_code","in":"query","required":false,"description":"Spoken language filter, e.g. en.","schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Repo__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"github.trending.repositories","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":1},"description":"GitHub's public Trending page: ranked repositories with description, language, stars, forks, stars gained in the range and the users who built them.","x-examples":[{"language":"python","since":"weekly"}]}},"/v1/github/trending/developers":{"get":{"operationId":"github.trending.developers","summary":"GitHub trending developers","tags":["github"],"parameters":[{"name":"language","in":"query","required":false,"description":"Coding language, e.g. javascript, python, go.","schema":{"type":"string"}},{"name":"since","in":"query","required":false,"description":"Trending range.","schema":{"type":"string","enum":["daily","weekly","monthly"],"default":"daily"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Profile__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"github.trending.developers","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":1},"description":"GitHub's public Trending developers page: ranked users with name, avatar and the popular repository GitHub shows for them (in `extra`).","x-examples":[{"language":"python","since":"weekly"}]}},"/v1/kwai/profile":{"get":{"operationId":"kwai.profile","summary":"Kwai profile","tags":["kwai"],"parameters":[{"name":"url","in":"query","required":false,"description":"Profile URL (kwai.com/@<user>).","schema":{"type":"string","format":"uri"},"x-hosts":["kwai.com"]},{"name":"handle","in":"query","required":false,"description":"Username, with or without the leading @.","schema":{"type":"string"},"x-aliases":["username"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Profile_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"kwai.profile","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"A public profile: name, bio, avatar, verification, counts of posts, likes, followers and following. Kwai's follower figure is unreliable (the official Brazil account reports 1), so treat it with care.","x-one-of":[["url","handle"]],"x-examples":[{"handle":"KwaiBrasilOficial"}]}},"/v1/kwai/profile/posts":{"get":{"operationId":"kwai.profile.posts","summary":"Kwai profile posts","tags":["kwai"],"parameters":[{"name":"url","in":"query","required":false,"description":"Profile URL (kwai.com/@<user>).","schema":{"type":"string","format":"uri"},"x-hosts":["kwai.com"]},{"name":"handle","in":"query","required":false,"description":"Username, with or without the leading @.","schema":{"type":"string"},"x-aliases":["username"]},{"name":"limit","in":"query","required":false,"description":"Number of posts per page, at most 50.","schema":{"type":"integer","minimum":1,"maximum":50},"x-aliases":["count"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"kwai.profile.posts","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"A user's public posts: caption, media URLs, covers, counts and author. Pass the cursor back for more.","x-one-of":[["url","handle"]],"x-examples":[{"handle":"KwaiBrasilOficial"}],"x-aliases":["/v1/kwai/user/posts"]}},"/v1/kwai/post":{"get":{"operationId":"kwai.post","summary":"Kwai post","tags":["kwai"],"parameters":[{"name":"url","in":"query","required":true,"description":"Post URL (kwai.com/@<user>/video/<id>; the /photo/<id> form works too).","schema":{"type":"string","format":"uri"},"x-hosts":["kwai.com"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Post_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"kwai.post","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"x-examples":[{"url":"https://www.kwai.com/@KwaiBrasilOficial/video/5193363430624671876"}]}},"/v1/rumble/video":{"get":{"operationId":"rumble.video","summary":"Rumble video details","tags":["rumble"],"parameters":[{"name":"url","in":"query","required":true,"description":"Video URL (rumble.com/v...-title.html).","schema":{"type":"string","format":"uri"},"x-hosts":["rumble.com"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Post_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"rumble.video","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"One video by link: title, description, channel, views, likes, comment count, duration, publish time, thumbnail, media URLs and caption languages. Embed links (rumble.com/embed/v...) work too.","x-examples":[{"url":"https://rumble.com/v79xhhm-discovery-why-glenn-wants-israel-to-sue-the-new-york-times.html"}]}},"/v1/rumble/channel/videos":{"get":{"operationId":"rumble.channel.videos","summary":"Rumble channel videos","tags":["rumble"],"parameters":[{"name":"handle","in":"query","required":false,"description":"Channel handle (the part after rumble.com/c/).","schema":{"type":"string"},"x-aliases":["username"]},{"name":"url","in":"query","required":false,"description":"Channel URL (rumble.com/c/<handle> or rumble.com/user/<handle>).","schema":{"type":"string","format":"uri"},"x-hosts":["rumble.com"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"rumble.channel.videos","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"A channel's videos (shorts are marked `type: short`) with the channel details in `parent`. Pass the cursor back for the next page of about 25.","x-one-of":[["handle","url"]],"x-examples":[{"handle":"CuteCats223"}]}},"/v1/rumble/search":{"get":{"operationId":"rumble.search","summary":"Rumble search","tags":["rumble"],"parameters":[{"name":"query","in":"query","required":true,"description":"Search terms.","schema":{"type":"string"},"x-aliases":["keyword","q"]},{"name":"sort","in":"query","required":false,"description":"Order of results. Changing it restarts the cursor chain.","schema":{"type":"string","enum":["relevance","views","latest"]},"x-aliases":["sort_by","sortBy","order"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"rumble.search","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Search Rumble videos. Each result has the title, channel, views, likes, duration, publish time and thumbnail; pass the cursor back for the next page of about 25.","x-examples":[{"query":"funny cats"}]}},"/v1/rumble/video/comments":{"get":{"operationId":"rumble.video.comments","summary":"Rumble video comments","tags":["rumble"],"parameters":[{"name":"url","in":"query","required":true,"description":"Video URL (rumble.com/v...-title.html).","schema":{"type":"string","format":"uri"},"x-hosts":["rumble.com"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Comment__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"rumble.video.comments","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"The comments on a video in one page, in Rumble's own order, with likes, dislikes and reply counts. Replies come after the comment they answer, with `parent_id` set. Videos whose comments Rumble shows only to signed-in users answer `private`. `parent` is the video.","x-examples":[{"url":"https://rumble.com/v79xhhm-discovery-why-glenn-wants-israel-to-sue-the-new-york-times.html"}]}},"/v1/rumble/video/transcript":{"get":{"operationId":"rumble.video.transcript","summary":"Rumble video transcript","tags":["rumble"],"parameters":[{"name":"url","in":"query","required":true,"description":"Video URL (rumble.com/v...-title.html).","schema":{"type":"string","format":"uri"},"x-hosts":["rumble.com"]},{"name":"allow_long_transcription","in":"query","required":false,"description":"Transcribe audio past 2 minutes with AI, at 5 credits per started minute of the whole video. Without it a longer video answers transcript_unavailable, which is free.","schema":{"type":"boolean","default":false},"x-aliases":["allowLongTranscription"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit for captions; AI transcription 1 up to 2 minutes, then 5 per started minute of the whole video.","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Transcript_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"rumble.video.transcript","x-credits":"transcript","x-credit-rule":"1 credit for captions; AI transcription 1 up to 2 minutes, then 5 per started minute of the whole video","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":180,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Captions when Rumble has them (its own auto captions count as captions); AI transcription of the audio when it does not.","x-examples":[{"url":"https://rumble.com/v79xhhm-discovery-why-glenn-wants-israel-to-sue-the-new-york-times.html"}]}},"/v1/telegram/channel":{"get":{"operationId":"telegram.channel","summary":"Telegram public channel","tags":["telegram"],"parameters":[{"name":"handle","in":"query","required":false,"description":"Channel username, without @.","schema":{"type":"string"},"x-aliases":["username"]},{"name":"url","in":"query","required":false,"description":"Channel URL (t.me/<name>).","schema":{"type":"string","format":"uri"},"x-hosts":["t.me","telegram.me"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Community_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"telegram.channel","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Name, description, avatar, verification, member count and media counters of a public channel or group, read from Telegram's public web preview (no Telegram account). Private and invite-only chats are not supported.","x-one-of":[["handle","url"]],"x-examples":[{"handle":"durov"}]}},"/v1/telegram/channel/posts":{"get":{"operationId":"telegram.channel.posts","summary":"Telegram public channel posts","tags":["telegram"],"parameters":[{"name":"handle","in":"query","required":false,"description":"Channel username, without @.","schema":{"type":"string"},"x-aliases":["username"]},{"name":"url","in":"query","required":false,"description":"Channel URL (t.me/<name>).","schema":{"type":"string","format":"uri"},"x-hosts":["t.me","telegram.me"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"telegram.channel.posts","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"One web-preview page of posts: text, date, views, reactions, forwards and media previews. The cursor (a post number) fetches the previous page.","x-one-of":[["handle","url"]],"x-examples":[{"handle":"durov"}]}},"/v1/telegram/post":{"get":{"operationId":"telegram.post","summary":"Telegram public post","tags":["telegram"],"parameters":[{"name":"url","in":"query","required":true,"description":"Post URL (t.me/<channel>/<number>).","schema":{"type":"string","format":"uri"},"x-hosts":["t.me","telegram.me"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Post_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"telegram.post","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"One public post by URL: text, date, views, reactions, forward source, media and link previews.","x-examples":[{"url":"https://t.me/durov/543"}]}},"/v1/cosmos/profile":{"get":{"operationId":"cosmos.profile","summary":"Cosmos profile","tags":["cosmos"],"parameters":[{"name":"handle","in":"query","required":true,"description":"Cosmos username, without a profile URL.","schema":{"type":"string"},"x-aliases":["username"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Profile_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"cosmos.profile","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"A public Cosmos profile: bio, links and follower counts.","x-examples":[{"handle":"design"}]}},"/v1/cosmos/profile/posts":{"get":{"operationId":"cosmos.profile.posts","summary":"Cosmos profile posts","tags":["cosmos"],"parameters":[{"name":"handle","in":"query","required":true,"description":"Cosmos username, without a profile URL.","schema":{"type":"string"},"x-aliases":["username"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"cosmos.profile.posts","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"The public posts saved to a profile. Keep the cursor unchanged and stop when `has_more` is false.","x-examples":[{"handle":"design"}],"x-aliases":["/v1/cosmos/user/posts"]}},"/v1/cosmos/profile/collections":{"get":{"operationId":"cosmos.profile.collections","summary":"Cosmos profile collections","tags":["cosmos"],"parameters":[{"name":"handle","in":"query","required":true,"description":"Cosmos username, without a profile URL.","schema":{"type":"string"},"x-aliases":["username"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Collection__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"cosmos.profile.collections","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"The public collections a user owns. Keep the cursor unchanged and stop when `has_more` is false.","x-examples":[{"handle":"design"}],"x-aliases":["/v1/cosmos/user/clusters"]}},"/v1/cosmos/post":{"get":{"operationId":"cosmos.post","summary":"Cosmos post","tags":["cosmos"],"parameters":[{"name":"url","in":"query","required":true,"description":"Public post URL (cosmos.so/e/<id>).","schema":{"type":"string","format":"uri"},"x-hosts":["cosmos.so"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Post_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"cosmos.post","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"A public Cosmos post: media URLs, captions, source links and the save count.","x-examples":[{"url":"https://www.cosmos.so/e/2107587668"}]}},"/v1/cosmos/collection":{"get":{"operationId":"cosmos.collection","summary":"Cosmos collection","tags":["cosmos"],"parameters":[{"name":"url","in":"query","required":true,"description":"Public collection URL (cosmos.so/<user>/<collection>).","schema":{"type":"string","format":"uri"},"x-hosts":["cosmos.so"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Collection_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"cosmos.collection","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"A public collection: owner, description, cover, counts and its public subcollections (in `extra`).","x-examples":[{"url":"https://www.cosmos.so/design/the-best-band-posters"}],"x-aliases":["/v1/cosmos/cluster"]}},"/v1/cosmos/collection/posts":{"get":{"operationId":"cosmos.collection.posts","summary":"Cosmos collection posts","tags":["cosmos"],"parameters":[{"name":"url","in":"query","required":true,"description":"Public collection URL (cosmos.so/<user>/<collection>).","schema":{"type":"string","format":"uri"},"x-hosts":["cosmos.so"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"cosmos.collection.posts","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Public posts saved to a collection; `parent` is the collection.","x-examples":[{"url":"https://www.cosmos.so/design/the-best-band-posters"}],"x-aliases":["/v1/cosmos/cluster/posts"]}},"/v1/cosmos/search":{"get":{"operationId":"cosmos.search","summary":"Cosmos search","tags":["cosmos"],"parameters":[{"name":"query","in":"query","required":true,"description":"Search terms.","schema":{"type":"string"},"x-aliases":["keyword","q"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit per successful request (a profile, a post, one page of a list).","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Post__"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"cosmos.search","x-credits":"standard","x-credit-rule":"1 credit per successful request (a profile, a post, one page of a list)","x-status":"ga","x-pool":"open","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Search public Cosmos posts by keyword. Cosmos may return related posts without an exact match.","x-examples":[{"query":"architecture"}]}},"/v1/transcript":{"get":{"operationId":"transcript","summary":"Transcript from any video URL","tags":["web"],"parameters":[{"name":"url","in":"query","required":true,"description":"Video URL on any supported platform.","schema":{"type":"string","format":"uri"},"x-hosts":["youtube.com","youtu.be","tiktok.com","instagram.com","instagr.am","x.com","twitter.com","rumble.com","twitch.tv","kick.com","facebook.com","fb.com","fb.watch","linkedin.com","reddit.com","redd.it"]},{"name":"language","in":"query","required":false,"description":"Preferred caption language (BCP 47).","schema":{"type":"string"},"x-aliases":["lang"]},{"name":"allow_long_transcription","in":"query","required":false,"description":"Transcribe audio past 2 minutes with AI, at 5 credits per started minute of the whole video. Without it a longer video answers transcript_unavailable, which is free.","schema":{"type":"boolean","default":false},"x-aliases":["allowLongTranscription"]},{"name":"trim","in":"query","required":false,"description":"Smaller response: drops null fields and `extra`.","schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"description":"Also return the platform's original object as `raw`.","schema":{"type":"boolean","default":false}},{"name":"max_age_days","in":"query","required":false,"description":"Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.","schema":{"type":"number","minimum":0,"maximum":30},"x-aliases":["cache_max_age"]}],"responses":{"200":{"description":"Success. Charge: 1 credit for captions; AI transcription 1 up to 2 minutes, then 5 per started minute of the whole video.","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Transcript_"}}}},"202":{"description":"Still running: poll `data.poll_url` (free); the finished job returns the final envelope and charges then, once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"transcript","x-credits":"transcript","x-credit-rule":"1 credit for captions; AI transcription 1 up to 2 minutes, then 5 per started minute of the whole video","x-status":"ga","x-pool":"native","x-mode":"sync","x-timeout-seconds":180,"x-cache":{"cacheable":true,"ttl_days":30},"description":"Detects the platform from the URL and runs its transcript endpoint: YouTube, TikTok, Instagram, X, Facebook, LinkedIn, Reddit, Twitch clips, Kick clips and Rumble. Same price, same cache.","x-examples":[{"url":"https://www.youtube.com/watch?v=dQw4w9WgXcQ"}]}},"/v1/account/credits":{"get":{"operationId":"account.credits","summary":"Credit balance","tags":["account"],"parameters":[],"responses":{"200":{"description":"Success. Charge: free.","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_CreditBalance_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"account.credits","x-credits":"free","x-credit-rule":"free","x-status":"ga","x-pool":"native","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":false,"ttl_days":1},"description":"The credits left for the team behind the key. Free.","x-examples":[{}],"x-aliases":["/v1/account/credit-balance"]}},"/v1/account/usage":{"get":{"operationId":"account.usage","summary":"Request history","tags":["account"],"parameters":[{"name":"endpoint","in":"query","required":false,"description":"Only requests whose path contains this text, \"/v1/tiktok/profile\".","schema":{"type":"string"}},{"name":"status","in":"query","required":false,"description":"Only requests that answered this HTTP status.","schema":{"type":"integer"},"x-aliases":["statusCode","status_code"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]}],"responses":{"200":{"description":"Success. Charge: free.","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_RequestLogEntry__"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"account.usage","x-credits":"free","x-credit-rule":"free","x-status":"ga","x-pool":"native","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":false,"ttl_days":1},"description":"The team's past API requests, newest first: endpoint, status, credits charged and time. Free. The cursor is the page number (at most 100 pages).","x-examples":[{}],"x-aliases":["/v1/account/get-api-usage"]}},"/v1/account/usage/daily":{"get":{"operationId":"account.usage.daily","summary":"Daily usage","tags":["account"],"parameters":[{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]}],"responses":{"200":{"description":"Success. Charge: free.","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_UsageStat__"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"account.usage.daily","x-credits":"free","x-credit-rule":"free","x-status":"ga","x-pool":"native","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":false,"ttl_days":1},"description":"Requests and credits charged per day for the last 30 days. Free.","x-examples":[{}],"x-aliases":["/v1/account/get-daily-usage-count"]}},"/v1/account/usage/routes":{"get":{"operationId":"account.usage.routes","summary":"Most used endpoints","tags":["account"],"parameters":[{"name":"start_time","in":"query","required":false,"description":"Start of the range, ISO 8601.","schema":{"type":"string"},"x-aliases":["startTime"]},{"name":"end_time","in":"query","required":false,"description":"End of the range, ISO 8601.","schema":{"type":"string"},"x-aliases":["endTime"]},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]}],"responses":{"200":{"description":"Success. Charge: free.","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_UsageStat__"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"account.usage.routes","x-credits":"free","x-credit-rule":"free","x-status":"ga","x-pool":"native","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":false,"ttl_days":1},"description":"The team's 20 most called endpoints with requests and credits charged each. Defaults to the last 24 hours; custom ranges up to one year. Free.","x-examples":[{}],"x-aliases":["/v1/account/get-most-used-routes"]}},"/v1/jobs/{job_id}":{"get":{"operationId":"jobs.by_id","summary":"Job result","tags":["account"],"parameters":[{"name":"job_id","in":"path","required":true,"description":"Job id from the 202 answer.","schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Charge: free.","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JobAccepted_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"jobs.by_id","x-credits":"free","x-credit-rule":"free","x-status":"ga","x-pool":"native","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":false,"ttl_days":1},"description":"Poll a job that answered 202. Free while pending; when done this returns the job's final envelope (and charges then, once).","x-examples":[{"job_id":"job_0123456789abcdef01234567"}]}},"/v1/batch":{"post":{"operationId":"batch.post","summary":"Batch requests","tags":["account"],"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"description":"Send the same value when retrying: the first answer is returned and nothing is charged twice. Kept 24 hours.","schema":{"type":"string","maxLength":255}}],"responses":{"200":{"description":"Success. Charge: the sum of each sub-request's charge.","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_BatchResult_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"batch.post","x-credits":"batch","x-credit-rule":"the sum of each sub-request's charge","x-status":"ga","x-pool":"native","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":false,"ttl_days":1},"description":"Up to 100 GET requests in one call; each result is a full envelope, charged as if called alone (cached repeats and failures free). Items run concurrently, each counts toward the rate limit, and a failed item never fails the others. Send an Idempotency-Key header to retry a batch safely: the first answer is replayed and nothing is charged twice.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["requests"],"properties":{"requests":{"type":"array","description":"List of {\"path\": \"/v1/...\", \"params\": {...}}."}}}}}},"x-examples":[{"requests":[{"path":"/v1/tiktok/profile","params":{"handle":"khaby.lame"}}]}]}},"/v1/monitors":{"post":{"operationId":"monitors.post","summary":"Create a monitor","tags":["account"],"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"description":"Send the same value when retrying: the first answer is returned and nothing is charged twice. Kept 24 hours.","schema":{"type":"string","maxLength":255}}],"responses":{"200":{"description":"Success. Charge: free.","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Monitor_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"monitors.post","x-credits":"free","x-credit-rule":"free","x-status":"ga","x-pool":"native","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":false,"ttl_days":1},"description":"Watch a list endpoint (a profile's posts, a search) and receive new items at a webhook.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","params","webhook_url"],"properties":{"endpoint":{"type":"string","description":"Path of a list endpoint, \"/v1/tiktok/profile/videos\"."},"params":{"type":"object","description":"That endpoint's params."},"interval_minutes":{"type":"integer","default":60,"minimum":15,"maximum":1440,"description":"How often to check."},"webhook_url":{"type":"string","description":"HTTPS URL that receives events."}}}}}},"x-examples":[{"endpoint":"/v1/tiktok/profile/videos","params":{"handle":"khaby.lame"},"webhook_url":"https://example.com/hook"}]},"get":{"operationId":"monitors","summary":"List monitors","tags":["account"],"parameters":[{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]}],"responses":{"200":{"description":"Success. Charge: free.","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_Monitor__"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"monitors","x-credits":"free","x-credit-rule":"free","x-status":"ga","x-pool":"native","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":false,"ttl_days":1},"x-examples":[{}]}},"/v1/monitors/{monitor_id}":{"delete":{"operationId":"monitors.by_id.delete","summary":"Delete a monitor","tags":["account"],"parameters":[{"name":"monitor_id","in":"path","required":true,"description":"Monitor id.","schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Charge: free.","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_Monitor_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"monitors.by_id.delete","x-credits":"free","x-credit-rule":"free","x-status":"ga","x-pool":"native","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":false,"ttl_days":1},"x-examples":[{"monitor_id":"mon_x"}]}},"/v1/monitors/{monitor_id}/test":{"post":{"operationId":"monitors.by_id.test.post","summary":"Send a test event","tags":["account"],"parameters":[{"name":"monitor_id","in":"path","required":true,"description":"Monitor id.","schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Charge: free.","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_WebhookTest_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"monitors.by_id.test.post","x-credits":"free","x-credit-rule":"free","x-status":"ga","x-pool":"native","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":false,"ttl_days":1},"description":"Send a signed test event (\"type\": \"test\") to the monitor's webhook now and report what the receiver answered. Free; nothing is stored.","x-examples":[{"monitor_id":"mon_x"}]}},"/v1/monitors/{monitor_id}/deliveries":{"get":{"operationId":"monitors.by_id.deliveries","summary":"Webhook delivery log","tags":["account"],"parameters":[{"name":"monitor_id","in":"path","required":true,"description":"Monitor id.","schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]}],"responses":{"200":{"description":"Success. Charge: free.","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_WebhookDelivery__"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"monitors.by_id.deliveries","x-credits":"free","x-credit-rule":"free","x-status":"ga","x-pool":"native","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":false,"ttl_days":1},"description":"Every delivery attempt of the monitor's events, newest first: status code, error, and whether the chain gave up (dead letter). Free.","x-examples":[{"monitor_id":"mon_x"}]}},"/v1/monitors/events/{event_id}/redeliver":{"post":{"operationId":"monitors.events.by_id.redeliver.post","summary":"Send an event again","tags":["account"],"parameters":[{"name":"event_id","in":"path","required":true,"description":"Event id.","schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Charge: free.","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_WebhookRedelivery_"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"monitors.events.by_id.redeliver.post","x-credits":"free","x-credit-rule":"free","x-status":"ga","x-pool":"native","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":false,"ttl_days":1},"description":"Queue an event that was not delivered (a dead letter, usually) for a fresh chain of attempts. An event already delivered is refused. Free.","x-examples":[{"event_id":"evt_x"}]}},"/v1/monitors/events":{"get":{"operationId":"monitors.events","summary":"Monitor events","tags":["account"],"parameters":[{"name":"monitor_id","in":"query","required":false,"description":"Only this monitor's events.","schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from the previous page; pass it back unchanged.","schema":{"type":"string"},"x-aliases":["continuationToken","continuation_token","next_max_id","max_id","max_cursor","min_time","after","page_token","pageToken","paginationToken","next_page_id","page"]}],"responses":{"200":{"description":"Success. Charge: free.","headers":{"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListPage_MonitorEvent__"}}}},"400":{"description":"Error (always free): `invalid_params`, `unsupported_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Error (always free): `unauthorized`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Error (always free): `insufficient_credits`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Error (always free): `forbidden`, `private`, `age_restricted`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Error (always free): `not_found`, `transcript_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Error (always free): `conflict`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Error (always free): `removed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Error (always free): `rate_limited`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"headers":{"retry-after":{"description":"Seconds to wait.","schema":{"type":"integer"}}}},"451":{"description":"Error (always free): `unavailable_in_region`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"Error (always free): `internal`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"Error (always free): `not_implemented`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Error (always free): `upstream_error`, `upstream_changed`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Error (always free): `upstream_rate_limited`, `upstream_blocked`, `overloaded`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Error (always free): `upstream_timeout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-endpoint-id":"monitors.events","x-credits":"free","x-credit-rule":"free","x-status":"ga","x-pool":"native","x-mode":"sync","x-timeout-seconds":30.0,"x-cache":{"cacheable":false,"ttl_days":1},"description":"Events from the team's monitors, newest first (the same events the webhooks deliver).","x-examples":[{}]}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"headers":{"x-request-id":{"description":"The request id, also in the body. Quote it to support.","schema":{"type":"string"}}},"schemas":{"Activity":{"additionalProperties":false,"description":"One public activity event (GitHub events).","properties":{"object":{"const":"activity","default":"activity","title":"Object","type":"string"},"platform":{"$ref":"#/components/schemas/Platform"},"id":{"title":"Id","type":"string"},"type":{"title":"Type","type":"string"},"actor":{"anyOf":[{"$ref":"#/components/schemas/Author"},{"type":"null"}],"default":null},"repo":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Repo"},"created_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"default":null,"title":"Created At"},"extra":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"title":"Extra"}},"required":["platform","id","type"],"title":"Activity","type":"object"},"Ad":{"additionalProperties":false,"properties":{"object":{"const":"ad","default":"ad","title":"Object","type":"string"},"platform":{"$ref":"#/components/schemas/Platform"},"id":{"title":"Id","type":"string"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Url"},"advertiser":{"anyOf":[{"$ref":"#/components/schemas/Advertiser"},{"type":"null"}],"default":null},"status":{"default":"unknown","enum":["active","inactive","unknown"],"title":"Status","type":"string"},"started_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"default":null,"title":"Started At"},"ended_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"default":null,"title":"Ended At"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Title"},"body":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Body"},"cta_text":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cta Text"},"landing_url":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Landing Url"},"format":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Format"},"media":{"$ref":"#/components/schemas/Media"},"regions":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"default":null,"title":"Regions"},"publisher_platforms":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"default":null,"title":"Publisher Platforms"},"impressions":{"anyOf":[{"$ref":"#/components/schemas/Range"},{"type":"null"}],"default":null},"spend":{"anyOf":[{"$ref":"#/components/schemas/Range"},{"type":"null"}],"default":null},"extra":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"title":"Extra"}},"required":["platform","id"],"title":"Ad","type":"object"},"Advertiser":{"additionalProperties":false,"properties":{"object":{"const":"advertiser","default":"advertiser","title":"Object","type":"string"},"platform":{"$ref":"#/components/schemas/Platform"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Name"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Url"},"page_id":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Page Id"},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Country"},"verified":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Verified"},"ad_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"title":"Ad Count"},"extra":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"title":"Extra"}},"required":["platform"],"title":"Advertiser","type":"object"},"Album":{"additionalProperties":false,"properties":{"object":{"const":"album","default":"album","title":"Object","type":"string"},"platform":{"$ref":"#/components/schemas/Platform"},"id":{"title":"Id","type":"string"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Url"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Title"},"artists":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"default":null,"title":"Artists"},"released_at":{"anyOf":[{"format":"date","type":"string"},{"type":"null"}],"default":null,"title":"Released At"},"track_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"title":"Track Count"},"cover_url":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cover Url"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Label"},"tracks":{"anyOf":[{"items":{"$ref":"#/components/schemas/Song"},"type":"array"},{"type":"null"}],"default":null,"title":"Tracks"},"extra":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"title":"Extra"}},"required":["platform","id"],"title":"Album","type":"object"},"Author":{"additionalProperties":false,"description":"Compact reference to a profile, embedded in posts, comments, ads.","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Id"},"handle":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Handle"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Name"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Url"},"avatar_url":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Avatar Url"},"verified":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Verified"}},"title":"Author","type":"object"},"BatchItem":{"additionalProperties":false,"description":"One envelope per batch request, in order. `response` is a full envelope.","properties":{"path":{"title":"Path","type":"string"},"status":{"title":"Status","type":"integer"},"response":{"additionalProperties":true,"title":"Response","type":"object"}},"required":["path","status","response"],"title":"BatchItem","type":"object"},"BatchResult":{"additionalProperties":false,"properties":{"object":{"const":"batch","default":"batch","title":"Object","type":"string"},"results":{"items":{"$ref":"#/components/schemas/BatchItem"},"title":"Results","type":"array"}},"required":["results"],"title":"BatchResult","type":"object"},"Collection":{"additionalProperties":false,"description":"An ordered set of items someone curates: playlists, boards, podcasts, highlights.","properties":{"object":{"const":"collection","default":"collection","title":"Object","type":"string"},"platform":{"$ref":"#/components/schemas/Platform"},"id":{"title":"Id","type":"string"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Url"},"kind":{"default":"unknown","enum":["playlist","board","podcast","highlight","topic","collection","unknown"],"title":"Kind","type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Title"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Description"},"owner":{"anyOf":[{"$ref":"#/components/schemas/Author"},{"type":"null"}],"default":null},"item_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"title":"Item Count"},"cover_url":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cover Url"},"updated_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"default":null,"title":"Updated At"},"extra":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"title":"Extra"}},"required":["platform","id"],"title":"Collection","type":"object"},"Comment":{"additionalProperties":false,"properties":{"object":{"const":"comment","default":"comment","title":"Object","type":"string"},"platform":{"$ref":"#/components/schemas/Platform"},"id":{"title":"Id","type":"string"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Url"},"post_id":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Post Id"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Parent Id"},"author":{"anyOf":[{"$ref":"#/components/schemas/Author"},{"type":"null"}],"default":null},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Text"},"published_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"default":null,"title":"Published At"},"stats":{"$ref":"#/components/schemas/CommentStats"},"is_pinned":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Is Pinned"},"is_by_creator":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Is By Creator"},"extra":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"title":"Extra"}},"required":["platform","id"],"title":"Comment","type":"object"},"CommentStats":{"additionalProperties":false,"properties":{"likes":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"title":"Likes"},"replies":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"title":"Replies"},"dislikes":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"title":"Dislikes"}},"title":"CommentStats","type":"object"},"Community":{"additionalProperties":false,"description":"A place people post into: subreddits, Facebook groups, X communities, Telegram channels.","properties":{"object":{"const":"community","default":"community","title":"Object","type":"string"},"platform":{"$ref":"#/components/schemas/Platform"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Id"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Url"},"kind":{"default":"unknown","enum":["subreddit","group","community","channel","unknown"],"title":"Kind","type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Name"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Title"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Description"},"avatar_url":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Avatar Url"},"banner_url":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Banner Url"},"member_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"title":"Member Count"},"online_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"title":"Online Count"},"is_nsfw":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Is Nsfw"},"is_private":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Is Private"},"verified":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Verified"},"created_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"default":null,"title":"Created At"},"extra":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"title":"Extra"}},"required":["platform"],"title":"Community","type":"object"},"ContributionDay":{"additionalProperties":false,"properties":{"date":{"format":"date","title":"Date","type":"string"},"count":{"title":"Count","type":"integer"}},"required":["date","count"],"title":"ContributionDay","type":"object"},"Contributions":{"additionalProperties":false,"properties":{"object":{"const":"contributions","default":"contributions","title":"Object","type":"string"},"platform":{"$ref":"#/components/schemas/Platform"},"handle":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Handle"},"total":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"title":"Total"},"days":{"anyOf":[{"items":{"$ref":"#/components/schemas/ContributionDay"},"type":"array"},{"type":"null"}],"default":null,"title":"Days"},"extra":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"title":"Extra"}},"required":["platform"],"title":"Contributions","type":"object"},"CreatorEmails":{"additionalProperties":false,"description":"Listed emails for a creator, each with where it was found.","properties":{"object":{"const":"creator_emails","default":"creator_emails","title":"Object","type":"string"},"platform":{"$ref":"#/components/schemas/Platform"},"handle":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Handle"},"profile_url":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Profile Url"},"emails":{"items":{"$ref":"#/components/schemas/FoundEmail"},"title":"Emails","type":"array"},"extra":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"title":"Extra"}},"required":["platform","emails"],"title":"CreatorEmails","type":"object"},"CreditBalance":{"additionalProperties":false,"properties":{"object":{"const":"credit_balance","default":"credit_balance","title":"Object","type":"string"},"credits_remaining":{"title":"Credits Remaining","type":"integer"},"team_id":{"title":"Team Id","type":"string"}},"required":["credits_remaining","team_id"],"title":"CreditBalance","type":"object"},"Embed":{"additionalProperties":false,"properties":{"object":{"const":"embed","default":"embed","title":"Object","type":"string"},"platform":{"$ref":"#/components/schemas/Platform"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Url"},"html":{"title":"Html","type":"string"},"extra":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"title":"Extra"}},"required":["platform","html"],"title":"Embed","type":"object"},"ErrorBody":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"title":"Message","type":"string"},"retryable":{"title":"Retryable","type":"boolean"}},"required":["code","message","retryable"],"title":"ErrorBody","type":"object"},"ErrorCode":{"enum":["invalid_params","unsupported_url","unauthorized","insufficient_credits","forbidden","rate_limited","conflict","not_found","private","age_restricted","removed","unavailable_in_region","transcript_unavailable","upstream_rate_limited","upstream_blocked","upstream_error","upstream_changed","upstream_timeout","overloaded","not_implemented","internal"],"title":"ErrorCode","type":"string"},"ErrorEnvelope":{"properties":{"ok":{"const":false,"default":false,"title":"Ok","type":"boolean"},"error":{"$ref":"#/components/schemas/ErrorBody"},"credits_charged":{"const":0,"default":0,"title":"Credits Charged","type":"integer"},"request_id":{"title":"Request Id","type":"string"}},"required":["error","request_id"],"title":"ErrorEnvelope","type":"object"},"Event":{"additionalProperties":false,"properties":{"object":{"const":"event","default":"event","title":"Object","type":"string"},"platform":{"$ref":"#/components/schemas/Platform"},"id":{"title":"Id","type":"string"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Url"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Title"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Description"},"starts_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"default":null,"title":"Starts At"},"ends_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"default":null,"title":"Ends At"},"place":{"anyOf":[{"$ref":"#/components/schemas/Place"},{"type":"null"}],"default":null},"is_online":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Is Online"},"host":{"anyOf":[{"$ref":"#/components/schemas/Author"},{"type":"null"}],"default":null},"going_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"title":"Going Count"},"interested_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"title":"Interested Count"},"cover_url":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cover Url"},"extra":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"title":"Extra"}},"required":["platform","id"],"title":"Event","type":"object"},"FoundEmail":{"additionalProperties":false,"properties":{"email":{"title":"Email","type":"string"},"source_url":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Source Url"},"kind":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Kind"}},"required":["email"],"title":"FoundEmail","type":"object"},"JobAccepted":{"additionalProperties":false,"description":"Answer for a job that is still running. Poll `poll_url` (free).","properties":{"object":{"const":"job","default":"job","title":"Object","type":"string"},"job_id":{"title":"Job Id","type":"string"},"status":{"enum":["pending","running"],"title":"Status","type":"string"},"poll_url":{"title":"Poll Url","type":"string"}},"required":["job_id","status","poll_url"],"title":"JobAccepted","type":"object"},"Link":{"additionalProperties":false,"properties":{"title":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Title"},"url":{"title":"Url","type":"string"}},"required":["url"],"title":"Link","type":"object"},"LinkPage":{"additionalProperties":false,"description":"A link-in-bio page (Linktree, Komi, Pillar, Linkbio, Linkme).","properties":{"object":{"const":"link_page","default":"link_page","title":"Object","type":"string"},"platform":{"$ref":"#/components/schemas/Platform"},"handle":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Handle"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Url"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Name"},"bio":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Bio"},"avatar_url":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Avatar Url"},"links":{"anyOf":[{"items":{"$ref":"#/components/schemas/Link"},"type":"array"},{"type":"null"}],"default":null,"title":"Links"},"socials":{"anyOf":[{"items":{"$ref":"#/components/schemas/Link"},"type":"array"},{"type":"null"}],"default":null,"title":"Socials"},"extra":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"title":"Extra"}},"required":["platform"],"title":"LinkPage","type":"object"},"ListPage_Activity_":{"additionalProperties":false,"properties":{"object":{"const":"list","default":"list","title":"Object","type":"string"},"items":{"items":{"$ref":"#/components/schemas/Activity"},"title":"Items","type":"array"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"default":false,"title":"Has More","type":"boolean"},"parent":{"anyOf":[{"discriminator":{"mapping":{"advertiser":"#/components/schemas/Advertiser","album":"#/components/schemas/Album","collection":"#/components/schemas/Collection","community":"#/components/schemas/Community","post":"#/components/schemas/Post","profile":"#/components/schemas/Profile","song":"#/components/schemas/Song"},"propertyName":"object"},"oneOf":[{"$ref":"#/components/schemas/Profile"},{"$ref":"#/components/schemas/Post"},{"$ref":"#/components/schemas/Collection"},{"$ref":"#/components/schemas/Community"},{"$ref":"#/components/schemas/Song"},{"$ref":"#/components/schemas/Album"},{"$ref":"#/components/schemas/Advertiser"}]},{"type":"null"}],"default":null,"title":"Parent"}},"required":["items"],"title":"ListPage[Activity]","type":"object"},"ListPage_Ad_":{"additionalProperties":false,"properties":{"object":{"const":"list","default":"list","title":"Object","type":"string"},"items":{"items":{"$ref":"#/components/schemas/Ad"},"title":"Items","type":"array"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"default":false,"title":"Has More","type":"boolean"},"parent":{"anyOf":[{"discriminator":{"mapping":{"advertiser":"#/components/schemas/Advertiser","album":"#/components/schemas/Album","collection":"#/components/schemas/Collection","community":"#/components/schemas/Community","post":"#/components/schemas/Post","profile":"#/components/schemas/Profile","song":"#/components/schemas/Song"},"propertyName":"object"},"oneOf":[{"$ref":"#/components/schemas/Profile"},{"$ref":"#/components/schemas/Post"},{"$ref":"#/components/schemas/Collection"},{"$ref":"#/components/schemas/Community"},{"$ref":"#/components/schemas/Song"},{"$ref":"#/components/schemas/Album"},{"$ref":"#/components/schemas/Advertiser"}]},{"type":"null"}],"default":null,"title":"Parent"}},"required":["items"],"title":"ListPage[Ad]","type":"object"},"ListPage_Advertiser_":{"additionalProperties":false,"properties":{"object":{"const":"list","default":"list","title":"Object","type":"string"},"items":{"items":{"$ref":"#/components/schemas/Advertiser"},"title":"Items","type":"array"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"default":false,"title":"Has More","type":"boolean"},"parent":{"anyOf":[{"discriminator":{"mapping":{"advertiser":"#/components/schemas/Advertiser","album":"#/components/schemas/Album","collection":"#/components/schemas/Collection","community":"#/components/schemas/Community","post":"#/components/schemas/Post","profile":"#/components/schemas/Profile","song":"#/components/schemas/Song"},"propertyName":"object"},"oneOf":[{"$ref":"#/components/schemas/Profile"},{"$ref":"#/components/schemas/Post"},{"$ref":"#/components/schemas/Collection"},{"$ref":"#/components/schemas/Community"},{"$ref":"#/components/schemas/Song"},{"$ref":"#/components/schemas/Album"},{"$ref":"#/components/schemas/Advertiser"}]},{"type":"null"}],"default":null,"title":"Parent"}},"required":["items"],"title":"ListPage[Advertiser]","type":"object"},"ListPage_Annotated_Union_Post__Profile__Collection__Community___FieldInfo_annotation_NoneType__required_True__discriminator__object____":{"additionalProperties":false,"properties":{"object":{"const":"list","default":"list","title":"Object","type":"string"},"items":{"items":{"discriminator":{"mapping":{"collection":"#/components/schemas/Collection","community":"#/components/schemas/Community","post":"#/components/schemas/Post","profile":"#/components/schemas/Profile"},"propertyName":"object"},"oneOf":[{"$ref":"#/components/schemas/Post"},{"$ref":"#/components/schemas/Profile"},{"$ref":"#/components/schemas/Collection"},{"$ref":"#/components/schemas/Community"}]},"title":"Items","type":"array"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"default":false,"title":"Has More","type":"boolean"},"parent":{"anyOf":[{"discriminator":{"mapping":{"advertiser":"#/components/schemas/Advertiser","album":"#/components/schemas/Album","collection":"#/components/schemas/Collection","community":"#/components/schemas/Community","post":"#/components/schemas/Post","profile":"#/components/schemas/Profile","song":"#/components/schemas/Song"},"propertyName":"object"},"oneOf":[{"$ref":"#/components/schemas/Profile"},{"$ref":"#/components/schemas/Post"},{"$ref":"#/components/schemas/Collection"},{"$ref":"#/components/schemas/Community"},{"$ref":"#/components/schemas/Song"},{"$ref":"#/components/schemas/Album"},{"$ref":"#/components/schemas/Advertiser"}]},{"type":"null"}],"default":null,"title":"Parent"}},"required":["items"],"title":"ListPage[Annotated[Union[Post, Profile, Collection, Community], FieldInfo(annotation=NoneType, required=True, discriminator='object')]]","type":"object"},"ListPage_Annotated_Union_Song__Album__Profile__Collection___FieldInfo_annotation_NoneType__required_True__discriminator__object____":{"additionalProperties":false,"properties":{"object":{"const":"list","default":"list","title":"Object","type":"string"},"items":{"items":{"discriminator":{"mapping":{"album":"#/components/schemas/Album","collection":"#/components/schemas/Collection","profile":"#/components/schemas/Profile","song":"#/components/schemas/Song"},"propertyName":"object"},"oneOf":[{"$ref":"#/components/schemas/Song"},{"$ref":"#/components/schemas/Album"},{"$ref":"#/components/schemas/Profile"},{"$ref":"#/components/schemas/Collection"}]},"title":"Items","type":"array"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"default":false,"title":"Has More","type":"boolean"},"parent":{"anyOf":[{"discriminator":{"mapping":{"advertiser":"#/components/schemas/Advertiser","album":"#/components/schemas/Album","collection":"#/components/schemas/Collection","community":"#/components/schemas/Community","post":"#/components/schemas/Post","profile":"#/components/schemas/Profile","song":"#/components/schemas/Song"},"propertyName":"object"},"oneOf":[{"$ref":"#/components/schemas/Profile"},{"$ref":"#/components/schemas/Post"},{"$ref":"#/components/schemas/Collection"},{"$ref":"#/components/schemas/Community"},{"$ref":"#/components/schemas/Song"},{"$ref":"#/components/schemas/Album"},{"$ref":"#/components/schemas/Advertiser"}]},{"type":"null"}],"default":null,"title":"Parent"}},"required":["items"],"title":"ListPage[Annotated[Union[Song, Album, Profile, Collection], FieldInfo(annotation=NoneType, required=True, discriminator='object')]]","type":"object"},"ListPage_Collection_":{"additionalProperties":false,"properties":{"object":{"const":"list","default":"list","title":"Object","type":"string"},"items":{"items":{"$ref":"#/components/schemas/Collection"},"title":"Items","type":"array"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"default":false,"title":"Has More","type":"boolean"},"parent":{"anyOf":[{"discriminator":{"mapping":{"advertiser":"#/components/schemas/Advertiser","album":"#/components/schemas/Album","collection":"#/components/schemas/Collection","community":"#/components/schemas/Community","post":"#/components/schemas/Post","profile":"#/components/schemas/Profile","song":"#/components/schemas/Song"},"propertyName":"object"},"oneOf":[{"$ref":"#/components/schemas/Profile"},{"$ref":"#/components/schemas/Post"},{"$ref":"#/components/schemas/Collection"},{"$ref":"#/components/schemas/Community"},{"$ref":"#/components/schemas/Song"},{"$ref":"#/components/schemas/Album"},{"$ref":"#/components/schemas/Advertiser"}]},{"type":"null"}],"default":null,"title":"Parent"}},"required":["items"],"title":"ListPage[Collection]","type":"object"},"ListPage_Comment_":{"additionalProperties":false,"properties":{"object":{"const":"list","default":"list","title":"Object","type":"string"},"items":{"items":{"$ref":"#/components/schemas/Comment"},"title":"Items","type":"array"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"default":false,"title":"Has More","type":"boolean"},"parent":{"anyOf":[{"discriminator":{"mapping":{"advertiser":"#/components/schemas/Advertiser","album":"#/components/schemas/Album","collection":"#/components/schemas/Collection","community":"#/components/schemas/Community","post":"#/components/schemas/Post","profile":"#/components/schemas/Profile","song":"#/components/schemas/Song"},"propertyName":"object"},"oneOf":[{"$ref":"#/components/schemas/Profile"},{"$ref":"#/components/schemas/Post"},{"$ref":"#/components/schemas/Collection"},{"$ref":"#/components/schemas/Community"},{"$ref":"#/components/schemas/Song"},{"$ref":"#/components/schemas/Album"},{"$ref":"#/components/schemas/Advertiser"}]},{"type":"null"}],"default":null,"title":"Parent"}},"required":["items"],"title":"ListPage[Comment]","type":"object"},"ListPage_Event_":{"additionalProperties":false,"properties":{"object":{"const":"list","default":"list","title":"Object","type":"string"},"items":{"items":{"$ref":"#/components/schemas/Event"},"title":"Items","type":"array"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"default":false,"title":"Has More","type":"boolean"},"parent":{"anyOf":[{"discriminator":{"mapping":{"advertiser":"#/components/schemas/Advertiser","album":"#/components/schemas/Album","collection":"#/components/schemas/Collection","community":"#/components/schemas/Community","post":"#/components/schemas/Post","profile":"#/components/schemas/Profile","song":"#/components/schemas/Song"},"propertyName":"object"},"oneOf":[{"$ref":"#/components/schemas/Profile"},{"$ref":"#/components/schemas/Post"},{"$ref":"#/components/schemas/Collection"},{"$ref":"#/components/schemas/Community"},{"$ref":"#/components/schemas/Song"},{"$ref":"#/components/schemas/Album"},{"$ref":"#/components/schemas/Advertiser"}]},{"type":"null"}],"default":null,"title":"Parent"}},"required":["items"],"title":"ListPage[Event]","type":"object"},"ListPage_Location_":{"additionalProperties":false,"properties":{"object":{"const":"list","default":"list","title":"Object","type":"string"},"items":{"items":{"$ref":"#/components/schemas/Location"},"title":"Items","type":"array"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"default":false,"title":"Has More","type":"boolean"},"parent":{"anyOf":[{"discriminator":{"mapping":{"advertiser":"#/components/schemas/Advertiser","album":"#/components/schemas/Album","collection":"#/components/schemas/Collection","community":"#/components/schemas/Community","post":"#/components/schemas/Post","profile":"#/components/schemas/Profile","song":"#/components/schemas/Song"},"propertyName":"object"},"oneOf":[{"$ref":"#/components/schemas/Profile"},{"$ref":"#/components/schemas/Post"},{"$ref":"#/components/schemas/Collection"},{"$ref":"#/components/schemas/Community"},{"$ref":"#/components/schemas/Song"},{"$ref":"#/components/schemas/Album"},{"$ref":"#/components/schemas/Advertiser"}]},{"type":"null"}],"default":null,"title":"Parent"}},"required":["items"],"title":"ListPage[Location]","type":"object"},"ListPage_MonitorEvent_":{"additionalProperties":false,"properties":{"object":{"const":"list","default":"list","title":"Object","type":"string"},"items":{"items":{"$ref":"#/components/schemas/MonitorEvent"},"title":"Items","type":"array"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"default":false,"title":"Has More","type":"boolean"},"parent":{"anyOf":[{"discriminator":{"mapping":{"advertiser":"#/components/schemas/Advertiser","album":"#/components/schemas/Album","collection":"#/components/schemas/Collection","community":"#/components/schemas/Community","post":"#/components/schemas/Post","profile":"#/components/schemas/Profile","song":"#/components/schemas/Song"},"propertyName":"object"},"oneOf":[{"$ref":"#/components/schemas/Profile"},{"$ref":"#/components/schemas/Post"},{"$ref":"#/components/schemas/Collection"},{"$ref":"#/components/schemas/Community"},{"$ref":"#/components/schemas/Song"},{"$ref":"#/components/schemas/Album"},{"$ref":"#/components/schemas/Advertiser"}]},{"type":"null"}],"default":null,"title":"Parent"}},"required":["items"],"title":"ListPage[MonitorEvent]","type":"object"},"ListPage_Monitor_":{"additionalProperties":false,"properties":{"object":{"const":"list","default":"list","title":"Object","type":"string"},"items":{"items":{"$ref":"#/components/schemas/Monitor"},"title":"Items","type":"array"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"default":false,"title":"Has More","type":"boolean"},"parent":{"anyOf":[{"discriminator":{"mapping":{"advertiser":"#/components/schemas/Advertiser","album":"#/components/schemas/Album","collection":"#/components/schemas/Collection","community":"#/components/schemas/Community","post":"#/components/schemas/Post","profile":"#/components/schemas/Profile","song":"#/components/schemas/Song"},"propertyName":"object"},"oneOf":[{"$ref":"#/components/schemas/Profile"},{"$ref":"#/components/schemas/Post"},{"$ref":"#/components/schemas/Collection"},{"$ref":"#/components/schemas/Community"},{"$ref":"#/components/schemas/Song"},{"$ref":"#/components/schemas/Album"},{"$ref":"#/components/schemas/Advertiser"}]},{"type":"null"}],"default":null,"title":"Parent"}},"required":["items"],"title":"ListPage[Monitor]","type":"object"},"ListPage_Post_":{"additionalProperties":false,"properties":{"object":{"const":"list","default":"list","title":"Object","type":"string"},"items":{"items":{"$ref":"#/components/schemas/Post"},"title":"Items","type":"array"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"default":false,"title":"Has More","type":"boolean"},"parent":{"anyOf":[{"discriminator":{"mapping":{"advertiser":"#/components/schemas/Advertiser","album":"#/components/schemas/Album","collection":"#/components/schemas/Collection","community":"#/components/schemas/Community","post":"#/components/schemas/Post","profile":"#/components/schemas/Profile","song":"#/components/schemas/Song"},"propertyName":"object"},"oneOf":[{"$ref":"#/components/schemas/Profile"},{"$ref":"#/components/schemas/Post"},{"$ref":"#/components/schemas/Collection"},{"$ref":"#/components/schemas/Community"},{"$ref":"#/components/schemas/Song"},{"$ref":"#/components/schemas/Album"},{"$ref":"#/components/schemas/Advertiser"}]},{"type":"null"}],"default":null,"title":"Parent"}},"required":["items"],"title":"ListPage[Post]","type":"object"},"ListPage_Product_":{"additionalProperties":false,"properties":{"object":{"const":"list","default":"list","title":"Object","type":"string"},"items":{"items":{"$ref":"#/components/schemas/Product"},"title":"Items","type":"array"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"default":false,"title":"Has More","type":"boolean"},"parent":{"anyOf":[{"discriminator":{"mapping":{"advertiser":"#/components/schemas/Advertiser","album":"#/components/schemas/Album","collection":"#/components/schemas/Collection","community":"#/components/schemas/Community","post":"#/components/schemas/Post","profile":"#/components/schemas/Profile","song":"#/components/schemas/Song"},"propertyName":"object"},"oneOf":[{"$ref":"#/components/schemas/Profile"},{"$ref":"#/components/schemas/Post"},{"$ref":"#/components/schemas/Collection"},{"$ref":"#/components/schemas/Community"},{"$ref":"#/components/schemas/Song"},{"$ref":"#/components/schemas/Album"},{"$ref":"#/components/schemas/Advertiser"}]},{"type":"null"}],"default":null,"title":"Parent"}},"required":["items"],"title":"ListPage[Product]","type":"object"},"ListPage_Profile_":{"additionalProperties":false,"properties":{"object":{"const":"list","default":"list","title":"Object","type":"string"},"items":{"items":{"$ref":"#/components/schemas/Profile"},"title":"Items","type":"array"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"default":false,"title":"Has More","type":"boolean"},"parent":{"anyOf":[{"discriminator":{"mapping":{"advertiser":"#/components/schemas/Advertiser","album":"#/components/schemas/Album","collection":"#/components/schemas/Collection","community":"#/components/schemas/Community","post":"#/components/schemas/Post","profile":"#/components/schemas/Profile","song":"#/components/schemas/Song"},"propertyName":"object"},"oneOf":[{"$ref":"#/components/schemas/Profile"},{"$ref":"#/components/schemas/Post"},{"$ref":"#/components/schemas/Collection"},{"$ref":"#/components/schemas/Community"},{"$ref":"#/components/schemas/Song"},{"$ref":"#/components/schemas/Album"},{"$ref":"#/components/schemas/Advertiser"}]},{"type":"null"}],"default":null,"title":"Parent"}},"required":["items"],"title":"ListPage[Profile]","type":"object"},"ListPage_PullRequest_":{"additionalProperties":false,"properties":{"object":{"const":"list","default":"list","title":"Object","type":"string"},"items":{"items":{"$ref":"#/components/schemas/PullRequest"},"title":"Items","type":"array"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"default":false,"title":"Has More","type":"boolean"},"parent":{"anyOf":[{"discriminator":{"mapping":{"advertiser":"#/components/schemas/Advertiser","album":"#/components/schemas/Album","collection":"#/components/schemas/Collection","community":"#/components/schemas/Community","post":"#/components/schemas/Post","profile":"#/components/schemas/Profile","song":"#/components/schemas/Song"},"propertyName":"object"},"oneOf":[{"$ref":"#/components/schemas/Profile"},{"$ref":"#/components/schemas/Post"},{"$ref":"#/components/schemas/Collection"},{"$ref":"#/components/schemas/Community"},{"$ref":"#/components/schemas/Song"},{"$ref":"#/components/schemas/Album"},{"$ref":"#/components/schemas/Advertiser"}]},{"type":"null"}],"default":null,"title":"Parent"}},"required":["items"],"title":"ListPage[PullRequest]","type":"object"},"ListPage_Repo_":{"additionalProperties":false,"properties":{"object":{"const":"list","default":"list","title":"Object","type":"string"},"items":{"items":{"$ref":"#/components/schemas/Repo"},"title":"Items","type":"array"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"default":false,"title":"Has More","type":"boolean"},"parent":{"anyOf":[{"discriminator":{"mapping":{"advertiser":"#/components/schemas/Advertiser","album":"#/components/schemas/Album","collection":"#/components/schemas/Collection","community":"#/components/schemas/Community","post":"#/components/schemas/Post","profile":"#/components/schemas/Profile","song":"#/components/schemas/Song"},"propertyName":"object"},"oneOf":[{"$ref":"#/components/schemas/Profile"},{"$ref":"#/components/schemas/Post"},{"$ref":"#/components/schemas/Collection"},{"$ref":"#/components/schemas/Community"},{"$ref":"#/components/schemas/Song"},{"$ref":"#/components/schemas/Album"},{"$ref":"#/components/schemas/Advertiser"}]},{"type":"null"}],"default":null,"title":"Parent"}},"required":["items"],"title":"ListPage[Repo]","type":"object"},"ListPage_RequestLogEntry_":{"additionalProperties":false,"properties":{"object":{"const":"list","default":"list","title":"Object","type":"string"},"items":{"items":{"$ref":"#/components/schemas/RequestLogEntry"},"title":"Items","type":"array"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"default":false,"title":"Has More","type":"boolean"},"parent":{"anyOf":[{"discriminator":{"mapping":{"advertiser":"#/components/schemas/Advertiser","album":"#/components/schemas/Album","collection":"#/components/schemas/Collection","community":"#/components/schemas/Community","post":"#/components/schemas/Post","profile":"#/components/schemas/Profile","song":"#/components/schemas/Song"},"propertyName":"object"},"oneOf":[{"$ref":"#/components/schemas/Profile"},{"$ref":"#/components/schemas/Post"},{"$ref":"#/components/schemas/Collection"},{"$ref":"#/components/schemas/Community"},{"$ref":"#/components/schemas/Song"},{"$ref":"#/components/schemas/Album"},{"$ref":"#/components/schemas/Advertiser"}]},{"type":"null"}],"default":null,"title":"Parent"}},"required":["items"],"title":"ListPage[RequestLogEntry]","type":"object"},"ListPage_Review_":{"additionalProperties":false,"properties":{"object":{"const":"list","default":"list","title":"Object","type":"string"},"items":{"items":{"$ref":"#/components/schemas/Review"},"title":"Items","type":"array"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"default":false,"title":"Has More","type":"boolean"},"parent":{"anyOf":[{"discriminator":{"mapping":{"advertiser":"#/components/schemas/Advertiser","album":"#/components/schemas/Album","collection":"#/components/schemas/Collection","community":"#/components/schemas/Community","post":"#/components/schemas/Post","profile":"#/components/schemas/Profile","song":"#/components/schemas/Song"},"propertyName":"object"},"oneOf":[{"$ref":"#/components/schemas/Profile"},{"$ref":"#/components/schemas/Post"},{"$ref":"#/components/schemas/Collection"},{"$ref":"#/components/schemas/Community"},{"$ref":"#/components/schemas/Song"},{"$ref":"#/components/schemas/Album"},{"$ref":"#/components/schemas/Advertiser"}]},{"type":"null"}],"default":null,"title":"Parent"}},"required":["items"],"title":"ListPage[Review]","type":"object"},"ListPage_Song_":{"additionalProperties":false,"properties":{"object":{"const":"list","default":"list","title":"Object","type":"string"},"items":{"items":{"$ref":"#/components/schemas/Song"},"title":"Items","type":"array"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"default":false,"title":"Has More","type":"boolean"},"parent":{"anyOf":[{"discriminator":{"mapping":{"advertiser":"#/components/schemas/Advertiser","album":"#/components/schemas/Album","collection":"#/components/schemas/Collection","community":"#/components/schemas/Community","post":"#/components/schemas/Post","profile":"#/components/schemas/Profile","song":"#/components/schemas/Song"},"propertyName":"object"},"oneOf":[{"$ref":"#/components/schemas/Profile"},{"$ref":"#/components/schemas/Post"},{"$ref":"#/components/schemas/Collection"},{"$ref":"#/components/schemas/Community"},{"$ref":"#/components/schemas/Song"},{"$ref":"#/components/schemas/Album"},{"$ref":"#/components/schemas/Advertiser"}]},{"type":"null"}],"default":null,"title":"Parent"}},"required":["items"],"title":"ListPage[Song]","type":"object"},"ListPage_Suggestion_":{"additionalProperties":false,"properties":{"object":{"const":"list","default":"list","title":"Object","type":"string"},"items":{"items":{"$ref":"#/components/schemas/Suggestion"},"title":"Items","type":"array"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"default":false,"title":"Has More","type":"boolean"},"parent":{"anyOf":[{"discriminator":{"mapping":{"advertiser":"#/components/schemas/Advertiser","album":"#/components/schemas/Album","collection":"#/components/schemas/Collection","community":"#/components/schemas/Community","post":"#/components/schemas/Post","profile":"#/components/schemas/Profile","song":"#/components/schemas/Song"},"propertyName":"object"},"oneOf":[{"$ref":"#/components/schemas/Profile"},{"$ref":"#/components/schemas/Post"},{"$ref":"#/components/schemas/Collection"},{"$ref":"#/components/schemas/Community"},{"$ref":"#/components/schemas/Song"},{"$ref":"#/components/schemas/Album"},{"$ref":"#/components/schemas/Advertiser"}]},{"type":"null"}],"default":null,"title":"Parent"}},"required":["items"],"title":"ListPage[Suggestion]","type":"object"},"ListPage_UsageStat_":{"additionalProperties":false,"properties":{"object":{"const":"list","default":"list","title":"Object","type":"string"},"items":{"items":{"$ref":"#/components/schemas/UsageStat"},"title":"Items","type":"array"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"default":false,"title":"Has More","type":"boolean"},"parent":{"anyOf":[{"discriminator":{"mapping":{"advertiser":"#/components/schemas/Advertiser","album":"#/components/schemas/Album","collection":"#/components/schemas/Collection","community":"#/components/schemas/Community","post":"#/components/schemas/Post","profile":"#/components/schemas/Profile","song":"#/components/schemas/Song"},"propertyName":"object"},"oneOf":[{"$ref":"#/components/schemas/Profile"},{"$ref":"#/components/schemas/Post"},{"$ref":"#/components/schemas/Collection"},{"$ref":"#/components/schemas/Community"},{"$ref":"#/components/schemas/Song"},{"$ref":"#/components/schemas/Album"},{"$ref":"#/components/schemas/Advertiser"}]},{"type":"null"}],"default":null,"title":"Parent"}},"required":["items"],"title":"ListPage[UsageStat]","type":"object"},"ListPage_WebhookDelivery_":{"additionalProperties":false,"properties":{"object":{"const":"list","default":"list","title":"Object","type":"string"},"items":{"items":{"$ref":"#/components/schemas/WebhookDelivery"},"title":"Items","type":"array"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"default":false,"title":"Has More","type":"boolean"},"parent":{"anyOf":[{"discriminator":{"mapping":{"advertiser":"#/components/schemas/Advertiser","album":"#/components/schemas/Album","collection":"#/components/schemas/Collection","community":"#/components/schemas/Community","post":"#/components/schemas/Post","profile":"#/components/schemas/Profile","song":"#/components/schemas/Song"},"propertyName":"object"},"oneOf":[{"$ref":"#/components/schemas/Profile"},{"$ref":"#/components/schemas/Post"},{"$ref":"#/components/schemas/Collection"},{"$ref":"#/components/schemas/Community"},{"$ref":"#/components/schemas/Song"},{"$ref":"#/components/schemas/Album"},{"$ref":"#/components/schemas/Advertiser"}]},{"type":"null"}],"default":null,"title":"Parent"}},"required":["items"],"title":"ListPage[WebhookDelivery]","type":"object"},"LiveStream":{"additionalProperties":false,"properties":{"object":{"const":"live_stream","default":"live_stream","title":"Object","type":"string"},"platform":{"$ref":"#/components/schemas/Platform"},"is_live":{"title":"Is Live","type":"boolean"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Id"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Url"},"author":{"anyOf":[{"$ref":"#/components/schemas/Author"},{"type":"null"}],"default":null},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Title"},"viewer_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"title":"Viewer Count"},"like_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"title":"Like Count"},"started_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"default":null,"title":"Started At"},"cover_url":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cover Url"},"extra":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"title":"Extra"}},"required":["platform","is_live"],"title":"LiveStream","type":"object"},"Location":{"additionalProperties":false,"description":"A named place with coordinates (Facebook Marketplace city search).","properties":{"object":{"const":"location","default":"location","title":"Object","type":"string"},"platform":{"$ref":"#/components/schemas/Platform"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Id"},"name":{"title":"Name","type":"string"},"region":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Region"},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Country"},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}],"default":null,"title":"Latitude"},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}],"default":null,"title":"Longitude"},"extra":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"title":"Extra"}},"required":["platform","name"],"title":"Location","type":"object"},"Media":{"additionalProperties":false,"properties":{"thumbnail_url":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Thumbnail Url"},"video_url":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Video Url"},"audio_url":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Audio Url"},"image_urls":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"default":null,"title":"Image Urls"},"width":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"title":"Width"},"height":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"title":"Height"}},"title":"Media","type":"object"},"Monitor":{"additionalProperties":false,"properties":{"object":{"const":"monitor","default":"monitor","title":"Object","type":"string"},"id":{"title":"Id","type":"string"},"endpoint":{"title":"Endpoint","type":"string"},"params":{"additionalProperties":true,"title":"Params","type":"object"},"interval_minutes":{"title":"Interval Minutes","type":"integer"},"webhook_url":{"title":"Webhook Url","type":"string"},"active":{"title":"Active","type":"boolean"},"created_at":{"format":"date-time","title":"Created At","type":"string"},"webhook_secret":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Webhook Secret"},"last_run_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"default":null,"title":"Last Run At"},"next_run_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"default":null,"title":"Next Run At"},"last_error":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Last Error"}},"required":["id","endpoint","params","interval_minutes","webhook_url","active","created_at"],"title":"Monitor","type":"object"},"MonitorEvent":{"additionalProperties":false,"properties":{"object":{"const":"monitor_event","default":"monitor_event","title":"Object","type":"string"},"id":{"title":"Id","type":"string"},"monitor_id":{"title":"Monitor Id","type":"string"},"type":{"const":"new_items","title":"Type","type":"string"},"items":{"items":{"additionalProperties":true,"type":"object"},"title":"Items","type":"array"},"created_at":{"format":"date-time","title":"Created At","type":"string"}},"required":["id","monitor_id","type","items","created_at"],"title":"MonitorEvent","type":"object"},"Place":{"additionalProperties":false,"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Name"},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Address"},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"City"},"region":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Region"},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Country"},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}],"default":null,"title":"Latitude"},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}],"default":null,"title":"Longitude"}},"title":"Place","type":"object"},"Platform":{"enum":["youtube","tiktok","instagram","reddit","bluesky","threads","truthsocial","pinterest","twitch","kick","snapchat","linktree","komi","pillar","linkbio","linkme","twitter","facebook","linkedin","amazon","spotify","apple_music","soundcloud","github","kwai","rumble","telegram","google","cosmos","web"],"title":"Platform","type":"string"},"Post":{"additionalProperties":false,"description":"Videos, reels, tweets, pins, clips, stories, Reddit posts: all posts with a `type`.","properties":{"object":{"const":"post","default":"post","title":"Object","type":"string"},"platform":{"$ref":"#/components/schemas/Platform"},"id":{"title":"Id","type":"string"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Url"},"type":{"default":"unknown","enum":["video","short","reel","image","carousel","story","live","clip","text","link","tweet","pin","community_post","episode","unknown"],"title":"Type","type":"string"},"author":{"anyOf":[{"$ref":"#/components/schemas/Author"},{"type":"null"}],"default":null},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Title"},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Text"},"published_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"default":null,"title":"Published At"},"duration_seconds":{"anyOf":[{"type":"number"},{"type":"null"}],"default":null,"title":"Duration Seconds"},"language":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Language"},"hashtags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"default":null,"title":"Hashtags"},"mentions":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"default":null,"title":"Mentions"},"stats":{"$ref":"#/components/schemas/Stats"},"media":{"$ref":"#/components/schemas/Media"},"song":{"anyOf":[{"$ref":"#/components/schemas/SongRef"},{"type":"null"}],"default":null},"location":{"anyOf":[{"$ref":"#/components/schemas/Place"},{"type":"null"}],"default":null},"is_pinned":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Is Pinned"},"is_sponsored":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Is Sponsored"},"extra":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"title":"Extra"}},"required":["platform","id"],"title":"Post","type":"object"},"Price":{"additionalProperties":false,"properties":{"amount":{"anyOf":[{"type":"number"},{"type":"null"}],"default":null,"title":"Amount"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Currency"},"original_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"default":null,"title":"Original Amount"},"display":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Display"}},"title":"Price","type":"object"},"Product":{"additionalProperties":false,"description":"Shop products and marketplace listings.","properties":{"object":{"const":"product","default":"product","title":"Object","type":"string"},"platform":{"$ref":"#/components/schemas/Platform"},"id":{"title":"Id","type":"string"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Url"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Title"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Description"},"price":{"anyOf":[{"$ref":"#/components/schemas/Price"},{"type":"null"}],"default":null},"seller":{"anyOf":[{"$ref":"#/components/schemas/Author"},{"type":"null"}],"default":null},"rating":{"anyOf":[{"type":"number"},{"type":"null"}],"default":null,"title":"Rating"},"review_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"title":"Review Count"},"sold_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"title":"Sold Count"},"image_urls":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"default":null,"title":"Image Urls"},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Category"},"in_stock":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"In Stock"},"location":{"anyOf":[{"$ref":"#/components/schemas/Place"},{"type":"null"}],"default":null},"published_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"default":null,"title":"Published At"},"extra":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"title":"Extra"}},"required":["platform","id"],"title":"Product","type":"object"},"Profile":{"additionalProperties":false,"properties":{"object":{"const":"profile","default":"profile","title":"Object","type":"string"},"platform":{"$ref":"#/components/schemas/Platform"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Id"},"handle":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Handle"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Name"},"headline":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Headline"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Url"},"kind":{"default":"unknown","enum":["person","creator","channel","page","company","artist","organization","shop","unknown"],"title":"Kind","type":"string"},"bio":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Bio"},"avatar_url":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Avatar Url"},"banner_url":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Banner Url"},"verified":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Verified"},"is_private":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Is Private"},"external_url":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"External Url"},"links":{"anyOf":[{"items":{"$ref":"#/components/schemas/Link"},"type":"array"},{"type":"null"}],"default":null,"title":"Links"},"location":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Location"},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Category"},"created_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"default":null,"title":"Created At"},"stats":{"$ref":"#/components/schemas/ProfileStats"},"extra":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"title":"Extra"}},"required":["platform"],"title":"Profile","type":"object"},"ProfileStats":{"additionalProperties":false,"properties":{"followers":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"title":"Followers"},"following":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"title":"Following"},"posts":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"title":"Posts"},"likes":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"title":"Likes"},"views":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"title":"Views"}},"title":"ProfileStats","type":"object"},"PullRequest":{"additionalProperties":false,"properties":{"object":{"const":"pull_request","default":"pull_request","title":"Object","type":"string"},"platform":{"$ref":"#/components/schemas/Platform"},"id":{"title":"Id","type":"string"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Url"},"repo":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Repo"},"number":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"title":"Number"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Title"},"state":{"default":"unknown","enum":["open","closed","merged","unknown"],"title":"State","type":"string"},"author":{"anyOf":[{"$ref":"#/components/schemas/Author"},{"type":"null"}],"default":null},"created_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"default":null,"title":"Created At"},"closed_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"default":null,"title":"Closed At"},"merged_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"default":null,"title":"Merged At"},"extra":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"title":"Extra"}},"required":["platform","id"],"title":"PullRequest","type":"object"},"Range":{"additionalProperties":false,"description":"A bounded estimate as ad libraries publish them (impressions, spend).","properties":{"lower":{"anyOf":[{"type":"number"},{"type":"null"}],"default":null,"title":"Lower"},"upper":{"anyOf":[{"type":"number"},{"type":"null"}],"default":null,"title":"Upper"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Currency"}},"title":"Range","type":"object"},"Repo":{"additionalProperties":false,"properties":{"object":{"const":"repo","default":"repo","title":"Object","type":"string"},"platform":{"$ref":"#/components/schemas/Platform"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Id"},"full_name":{"title":"Full Name","type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Name"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Url"},"owner":{"anyOf":[{"$ref":"#/components/schemas/Author"},{"type":"null"}],"default":null},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Description"},"language":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Language"},"topics":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"default":null,"title":"Topics"},"license":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"License"},"stars":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"title":"Stars"},"forks":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"title":"Forks"},"watchers":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"title":"Watchers"},"open_issues":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"title":"Open Issues"},"is_fork":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Is Fork"},"is_archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Is Archived"},"default_branch":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Default Branch"},"created_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"default":null,"title":"Created At"},"updated_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"default":null,"title":"Updated At"},"pushed_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"default":null,"title":"Pushed At"},"extra":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"title":"Extra"}},"required":["platform","full_name"],"title":"Repo","type":"object"},"RequestLogEntry":{"additionalProperties":false,"description":"One past API request of the team (account request history).","properties":{"object":{"const":"request_log","default":"request_log","title":"Object","type":"string"},"request_id":{"title":"Request Id","type":"string"},"endpoint":{"title":"Endpoint","type":"string"},"endpoint_id":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Endpoint Id"},"status":{"title":"Status","type":"integer"},"credits_charged":{"title":"Credits Charged","type":"integer"},"cached":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Cached"},"created_at":{"format":"date-time","title":"Created At","type":"string"}},"required":["request_id","endpoint","status","credits_charged","created_at"],"title":"RequestLogEntry","type":"object"},"Review":{"additionalProperties":false,"properties":{"object":{"const":"review","default":"review","title":"Object","type":"string"},"platform":{"$ref":"#/components/schemas/Platform"},"id":{"title":"Id","type":"string"},"product_id":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Product Id"},"author":{"anyOf":[{"$ref":"#/components/schemas/Author"},{"type":"null"}],"default":null},"rating":{"anyOf":[{"type":"number"},{"type":"null"}],"default":null,"title":"Rating"},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Text"},"published_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"default":null,"title":"Published At"},"image_urls":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"default":null,"title":"Image Urls"},"extra":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"title":"Extra"}},"required":["platform","id"],"title":"Review","type":"object"},"Song":{"additionalProperties":false,"description":"A sound or music track (TikTok sounds, Spotify/Apple/SoundCloud tracks).","properties":{"object":{"const":"song","default":"song","title":"Object","type":"string"},"platform":{"$ref":"#/components/schemas/Platform"},"id":{"title":"Id","type":"string"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Url"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Title"},"artists":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"default":null,"title":"Artists"},"album":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Album"},"duration_seconds":{"anyOf":[{"type":"number"},{"type":"null"}],"default":null,"title":"Duration Seconds"},"cover_url":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cover Url"},"preview_url":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Preview Url"},"released_at":{"anyOf":[{"format":"date","type":"string"},{"type":"null"}],"default":null,"title":"Released At"},"isrc":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Isrc"},"explicit":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Explicit"},"is_original":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Is Original"},"stats":{"$ref":"#/components/schemas/SongStats"},"extra":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"title":"Extra"}},"required":["platform","id"],"title":"Song","type":"object"},"SongRef":{"additionalProperties":false,"description":"The sound used by a post (TikTok, Reels, Shorts).","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Id"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Title"},"artist":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Artist"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Url"}},"title":"SongRef","type":"object"},"SongStats":{"additionalProperties":false,"properties":{"plays":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"title":"Plays"},"uses":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"title":"Uses"},"likes":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"title":"Likes"}},"title":"SongStats","type":"object"},"Stats":{"additionalProperties":false,"description":"Engagement on a post. Same five names on every platform.","properties":{"views":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"title":"Views"},"likes":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"title":"Likes"},"comments":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"title":"Comments"},"shares":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"title":"Shares"},"saves":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"title":"Saves"},"dislikes":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"title":"Dislikes"}},"title":"Stats","type":"object"},"SuccessEnvelope_Ad_":{"properties":{"ok":{"const":true,"default":true,"title":"Ok","type":"boolean"},"credits_charged":{"title":"Credits Charged","type":"integer"},"credits_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Remaining"},"cached":{"title":"Cached","type":"boolean"},"cached_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Cached At"},"request_id":{"title":"Request Id","type":"string"},"data":{"$ref":"#/components/schemas/Ad"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Has More"},"raw":{"default":null,"title":"Raw"}},"required":["credits_charged","credits_remaining","cached","cached_at","request_id","data"],"title":"SuccessEnvelope[Ad]","type":"object"},"SuccessEnvelope_Album_":{"properties":{"ok":{"const":true,"default":true,"title":"Ok","type":"boolean"},"credits_charged":{"title":"Credits Charged","type":"integer"},"credits_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Remaining"},"cached":{"title":"Cached","type":"boolean"},"cached_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Cached At"},"request_id":{"title":"Request Id","type":"string"},"data":{"$ref":"#/components/schemas/Album"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Has More"},"raw":{"default":null,"title":"Raw"}},"required":["credits_charged","credits_remaining","cached","cached_at","request_id","data"],"title":"SuccessEnvelope[Album]","type":"object"},"SuccessEnvelope_BatchResult_":{"properties":{"ok":{"const":true,"default":true,"title":"Ok","type":"boolean"},"credits_charged":{"title":"Credits Charged","type":"integer"},"credits_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Remaining"},"cached":{"title":"Cached","type":"boolean"},"cached_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Cached At"},"request_id":{"title":"Request Id","type":"string"},"data":{"$ref":"#/components/schemas/BatchResult"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Has More"},"raw":{"default":null,"title":"Raw"}},"required":["credits_charged","credits_remaining","cached","cached_at","request_id","data"],"title":"SuccessEnvelope[BatchResult]","type":"object"},"SuccessEnvelope_Collection_":{"properties":{"ok":{"const":true,"default":true,"title":"Ok","type":"boolean"},"credits_charged":{"title":"Credits Charged","type":"integer"},"credits_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Remaining"},"cached":{"title":"Cached","type":"boolean"},"cached_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Cached At"},"request_id":{"title":"Request Id","type":"string"},"data":{"$ref":"#/components/schemas/Collection"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Has More"},"raw":{"default":null,"title":"Raw"}},"required":["credits_charged","credits_remaining","cached","cached_at","request_id","data"],"title":"SuccessEnvelope[Collection]","type":"object"},"SuccessEnvelope_Community_":{"properties":{"ok":{"const":true,"default":true,"title":"Ok","type":"boolean"},"credits_charged":{"title":"Credits Charged","type":"integer"},"credits_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Remaining"},"cached":{"title":"Cached","type":"boolean"},"cached_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Cached At"},"request_id":{"title":"Request Id","type":"string"},"data":{"$ref":"#/components/schemas/Community"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Has More"},"raw":{"default":null,"title":"Raw"}},"required":["credits_charged","credits_remaining","cached","cached_at","request_id","data"],"title":"SuccessEnvelope[Community]","type":"object"},"SuccessEnvelope_Contributions_":{"properties":{"ok":{"const":true,"default":true,"title":"Ok","type":"boolean"},"credits_charged":{"title":"Credits Charged","type":"integer"},"credits_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Remaining"},"cached":{"title":"Cached","type":"boolean"},"cached_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Cached At"},"request_id":{"title":"Request Id","type":"string"},"data":{"$ref":"#/components/schemas/Contributions"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Has More"},"raw":{"default":null,"title":"Raw"}},"required":["credits_charged","credits_remaining","cached","cached_at","request_id","data"],"title":"SuccessEnvelope[Contributions]","type":"object"},"SuccessEnvelope_CreatorEmails_":{"properties":{"ok":{"const":true,"default":true,"title":"Ok","type":"boolean"},"credits_charged":{"title":"Credits Charged","type":"integer"},"credits_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Remaining"},"cached":{"title":"Cached","type":"boolean"},"cached_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Cached At"},"request_id":{"title":"Request Id","type":"string"},"data":{"$ref":"#/components/schemas/CreatorEmails"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Has More"},"raw":{"default":null,"title":"Raw"}},"required":["credits_charged","credits_remaining","cached","cached_at","request_id","data"],"title":"SuccessEnvelope[CreatorEmails]","type":"object"},"SuccessEnvelope_CreditBalance_":{"properties":{"ok":{"const":true,"default":true,"title":"Ok","type":"boolean"},"credits_charged":{"title":"Credits Charged","type":"integer"},"credits_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Remaining"},"cached":{"title":"Cached","type":"boolean"},"cached_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Cached At"},"request_id":{"title":"Request Id","type":"string"},"data":{"$ref":"#/components/schemas/CreditBalance"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Has More"},"raw":{"default":null,"title":"Raw"}},"required":["credits_charged","credits_remaining","cached","cached_at","request_id","data"],"title":"SuccessEnvelope[CreditBalance]","type":"object"},"SuccessEnvelope_Embed_":{"properties":{"ok":{"const":true,"default":true,"title":"Ok","type":"boolean"},"credits_charged":{"title":"Credits Charged","type":"integer"},"credits_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Remaining"},"cached":{"title":"Cached","type":"boolean"},"cached_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Cached At"},"request_id":{"title":"Request Id","type":"string"},"data":{"$ref":"#/components/schemas/Embed"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Has More"},"raw":{"default":null,"title":"Raw"}},"required":["credits_charged","credits_remaining","cached","cached_at","request_id","data"],"title":"SuccessEnvelope[Embed]","type":"object"},"SuccessEnvelope_Event_":{"properties":{"ok":{"const":true,"default":true,"title":"Ok","type":"boolean"},"credits_charged":{"title":"Credits Charged","type":"integer"},"credits_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Remaining"},"cached":{"title":"Cached","type":"boolean"},"cached_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Cached At"},"request_id":{"title":"Request Id","type":"string"},"data":{"$ref":"#/components/schemas/Event"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Has More"},"raw":{"default":null,"title":"Raw"}},"required":["credits_charged","credits_remaining","cached","cached_at","request_id","data"],"title":"SuccessEnvelope[Event]","type":"object"},"SuccessEnvelope_JobAccepted_":{"properties":{"ok":{"const":true,"default":true,"title":"Ok","type":"boolean"},"credits_charged":{"title":"Credits Charged","type":"integer"},"credits_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Remaining"},"cached":{"title":"Cached","type":"boolean"},"cached_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Cached At"},"request_id":{"title":"Request Id","type":"string"},"data":{"$ref":"#/components/schemas/JobAccepted"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Has More"},"raw":{"default":null,"title":"Raw"}},"required":["credits_charged","credits_remaining","cached","cached_at","request_id","data"],"title":"SuccessEnvelope[JobAccepted]","type":"object"},"SuccessEnvelope_LinkPage_":{"properties":{"ok":{"const":true,"default":true,"title":"Ok","type":"boolean"},"credits_charged":{"title":"Credits Charged","type":"integer"},"credits_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Remaining"},"cached":{"title":"Cached","type":"boolean"},"cached_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Cached At"},"request_id":{"title":"Request Id","type":"string"},"data":{"$ref":"#/components/schemas/LinkPage"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Has More"},"raw":{"default":null,"title":"Raw"}},"required":["credits_charged","credits_remaining","cached","cached_at","request_id","data"],"title":"SuccessEnvelope[LinkPage]","type":"object"},"SuccessEnvelope_ListPage_Activity__":{"properties":{"ok":{"const":true,"default":true,"title":"Ok","type":"boolean"},"credits_charged":{"title":"Credits Charged","type":"integer"},"credits_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Remaining"},"cached":{"title":"Cached","type":"boolean"},"cached_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Cached At"},"request_id":{"title":"Request Id","type":"string"},"data":{"$ref":"#/components/schemas/ListPage_Activity_"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Has More"},"raw":{"default":null,"title":"Raw"}},"required":["credits_charged","credits_remaining","cached","cached_at","request_id","data"],"title":"SuccessEnvelope[ListPage[Activity]]","type":"object"},"SuccessEnvelope_ListPage_Ad__":{"properties":{"ok":{"const":true,"default":true,"title":"Ok","type":"boolean"},"credits_charged":{"title":"Credits Charged","type":"integer"},"credits_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Remaining"},"cached":{"title":"Cached","type":"boolean"},"cached_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Cached At"},"request_id":{"title":"Request Id","type":"string"},"data":{"$ref":"#/components/schemas/ListPage_Ad_"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Has More"},"raw":{"default":null,"title":"Raw"}},"required":["credits_charged","credits_remaining","cached","cached_at","request_id","data"],"title":"SuccessEnvelope[ListPage[Ad]]","type":"object"},"SuccessEnvelope_ListPage_Advertiser__":{"properties":{"ok":{"const":true,"default":true,"title":"Ok","type":"boolean"},"credits_charged":{"title":"Credits Charged","type":"integer"},"credits_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Remaining"},"cached":{"title":"Cached","type":"boolean"},"cached_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Cached At"},"request_id":{"title":"Request Id","type":"string"},"data":{"$ref":"#/components/schemas/ListPage_Advertiser_"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Has More"},"raw":{"default":null,"title":"Raw"}},"required":["credits_charged","credits_remaining","cached","cached_at","request_id","data"],"title":"SuccessEnvelope[ListPage[Advertiser]]","type":"object"},"SuccessEnvelope_ListPage_Annotated_Union_Post__Profile__Collection__Community___FieldInfo_annotation_NoneType__required_True__discriminator__object_____":{"properties":{"ok":{"const":true,"default":true,"title":"Ok","type":"boolean"},"credits_charged":{"title":"Credits Charged","type":"integer"},"credits_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Remaining"},"cached":{"title":"Cached","type":"boolean"},"cached_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Cached At"},"request_id":{"title":"Request Id","type":"string"},"data":{"$ref":"#/components/schemas/ListPage_Annotated_Union_Post__Profile__Collection__Community___FieldInfo_annotation_NoneType__required_True__discriminator__object____"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Has More"},"raw":{"default":null,"title":"Raw"}},"required":["credits_charged","credits_remaining","cached","cached_at","request_id","data"],"title":"SuccessEnvelope[ListPage[Annotated[Union[Post, Profile, Collection, Community], FieldInfo(annotation=NoneType, required=True, discriminator='object')]]]","type":"object"},"SuccessEnvelope_ListPage_Annotated_Union_Song__Album__Profile__Collection___FieldInfo_annotation_NoneType__required_True__discriminator__object_____":{"properties":{"ok":{"const":true,"default":true,"title":"Ok","type":"boolean"},"credits_charged":{"title":"Credits Charged","type":"integer"},"credits_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Remaining"},"cached":{"title":"Cached","type":"boolean"},"cached_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Cached At"},"request_id":{"title":"Request Id","type":"string"},"data":{"$ref":"#/components/schemas/ListPage_Annotated_Union_Song__Album__Profile__Collection___FieldInfo_annotation_NoneType__required_True__discriminator__object____"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Has More"},"raw":{"default":null,"title":"Raw"}},"required":["credits_charged","credits_remaining","cached","cached_at","request_id","data"],"title":"SuccessEnvelope[ListPage[Annotated[Union[Song, Album, Profile, Collection], FieldInfo(annotation=NoneType, required=True, discriminator='object')]]]","type":"object"},"SuccessEnvelope_ListPage_Collection__":{"properties":{"ok":{"const":true,"default":true,"title":"Ok","type":"boolean"},"credits_charged":{"title":"Credits Charged","type":"integer"},"credits_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Remaining"},"cached":{"title":"Cached","type":"boolean"},"cached_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Cached At"},"request_id":{"title":"Request Id","type":"string"},"data":{"$ref":"#/components/schemas/ListPage_Collection_"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Has More"},"raw":{"default":null,"title":"Raw"}},"required":["credits_charged","credits_remaining","cached","cached_at","request_id","data"],"title":"SuccessEnvelope[ListPage[Collection]]","type":"object"},"SuccessEnvelope_ListPage_Comment__":{"properties":{"ok":{"const":true,"default":true,"title":"Ok","type":"boolean"},"credits_charged":{"title":"Credits Charged","type":"integer"},"credits_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Remaining"},"cached":{"title":"Cached","type":"boolean"},"cached_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Cached At"},"request_id":{"title":"Request Id","type":"string"},"data":{"$ref":"#/components/schemas/ListPage_Comment_"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Has More"},"raw":{"default":null,"title":"Raw"}},"required":["credits_charged","credits_remaining","cached","cached_at","request_id","data"],"title":"SuccessEnvelope[ListPage[Comment]]","type":"object"},"SuccessEnvelope_ListPage_Event__":{"properties":{"ok":{"const":true,"default":true,"title":"Ok","type":"boolean"},"credits_charged":{"title":"Credits Charged","type":"integer"},"credits_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Remaining"},"cached":{"title":"Cached","type":"boolean"},"cached_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Cached At"},"request_id":{"title":"Request Id","type":"string"},"data":{"$ref":"#/components/schemas/ListPage_Event_"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Has More"},"raw":{"default":null,"title":"Raw"}},"required":["credits_charged","credits_remaining","cached","cached_at","request_id","data"],"title":"SuccessEnvelope[ListPage[Event]]","type":"object"},"SuccessEnvelope_ListPage_Location__":{"properties":{"ok":{"const":true,"default":true,"title":"Ok","type":"boolean"},"credits_charged":{"title":"Credits Charged","type":"integer"},"credits_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Remaining"},"cached":{"title":"Cached","type":"boolean"},"cached_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Cached At"},"request_id":{"title":"Request Id","type":"string"},"data":{"$ref":"#/components/schemas/ListPage_Location_"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Has More"},"raw":{"default":null,"title":"Raw"}},"required":["credits_charged","credits_remaining","cached","cached_at","request_id","data"],"title":"SuccessEnvelope[ListPage[Location]]","type":"object"},"SuccessEnvelope_ListPage_MonitorEvent__":{"properties":{"ok":{"const":true,"default":true,"title":"Ok","type":"boolean"},"credits_charged":{"title":"Credits Charged","type":"integer"},"credits_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Remaining"},"cached":{"title":"Cached","type":"boolean"},"cached_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Cached At"},"request_id":{"title":"Request Id","type":"string"},"data":{"$ref":"#/components/schemas/ListPage_MonitorEvent_"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Has More"},"raw":{"default":null,"title":"Raw"}},"required":["credits_charged","credits_remaining","cached","cached_at","request_id","data"],"title":"SuccessEnvelope[ListPage[MonitorEvent]]","type":"object"},"SuccessEnvelope_ListPage_Monitor__":{"properties":{"ok":{"const":true,"default":true,"title":"Ok","type":"boolean"},"credits_charged":{"title":"Credits Charged","type":"integer"},"credits_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Remaining"},"cached":{"title":"Cached","type":"boolean"},"cached_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Cached At"},"request_id":{"title":"Request Id","type":"string"},"data":{"$ref":"#/components/schemas/ListPage_Monitor_"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Has More"},"raw":{"default":null,"title":"Raw"}},"required":["credits_charged","credits_remaining","cached","cached_at","request_id","data"],"title":"SuccessEnvelope[ListPage[Monitor]]","type":"object"},"SuccessEnvelope_ListPage_Post__":{"properties":{"ok":{"const":true,"default":true,"title":"Ok","type":"boolean"},"credits_charged":{"title":"Credits Charged","type":"integer"},"credits_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Remaining"},"cached":{"title":"Cached","type":"boolean"},"cached_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Cached At"},"request_id":{"title":"Request Id","type":"string"},"data":{"$ref":"#/components/schemas/ListPage_Post_"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Has More"},"raw":{"default":null,"title":"Raw"}},"required":["credits_charged","credits_remaining","cached","cached_at","request_id","data"],"title":"SuccessEnvelope[ListPage[Post]]","type":"object"},"SuccessEnvelope_ListPage_Product__":{"properties":{"ok":{"const":true,"default":true,"title":"Ok","type":"boolean"},"credits_charged":{"title":"Credits Charged","type":"integer"},"credits_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Remaining"},"cached":{"title":"Cached","type":"boolean"},"cached_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Cached At"},"request_id":{"title":"Request Id","type":"string"},"data":{"$ref":"#/components/schemas/ListPage_Product_"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Has More"},"raw":{"default":null,"title":"Raw"}},"required":["credits_charged","credits_remaining","cached","cached_at","request_id","data"],"title":"SuccessEnvelope[ListPage[Product]]","type":"object"},"SuccessEnvelope_ListPage_Profile__":{"properties":{"ok":{"const":true,"default":true,"title":"Ok","type":"boolean"},"credits_charged":{"title":"Credits Charged","type":"integer"},"credits_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Remaining"},"cached":{"title":"Cached","type":"boolean"},"cached_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Cached At"},"request_id":{"title":"Request Id","type":"string"},"data":{"$ref":"#/components/schemas/ListPage_Profile_"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Has More"},"raw":{"default":null,"title":"Raw"}},"required":["credits_charged","credits_remaining","cached","cached_at","request_id","data"],"title":"SuccessEnvelope[ListPage[Profile]]","type":"object"},"SuccessEnvelope_ListPage_PullRequest__":{"properties":{"ok":{"const":true,"default":true,"title":"Ok","type":"boolean"},"credits_charged":{"title":"Credits Charged","type":"integer"},"credits_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Remaining"},"cached":{"title":"Cached","type":"boolean"},"cached_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Cached At"},"request_id":{"title":"Request Id","type":"string"},"data":{"$ref":"#/components/schemas/ListPage_PullRequest_"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Has More"},"raw":{"default":null,"title":"Raw"}},"required":["credits_charged","credits_remaining","cached","cached_at","request_id","data"],"title":"SuccessEnvelope[ListPage[PullRequest]]","type":"object"},"SuccessEnvelope_ListPage_Repo__":{"properties":{"ok":{"const":true,"default":true,"title":"Ok","type":"boolean"},"credits_charged":{"title":"Credits Charged","type":"integer"},"credits_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Remaining"},"cached":{"title":"Cached","type":"boolean"},"cached_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Cached At"},"request_id":{"title":"Request Id","type":"string"},"data":{"$ref":"#/components/schemas/ListPage_Repo_"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Has More"},"raw":{"default":null,"title":"Raw"}},"required":["credits_charged","credits_remaining","cached","cached_at","request_id","data"],"title":"SuccessEnvelope[ListPage[Repo]]","type":"object"},"SuccessEnvelope_ListPage_RequestLogEntry__":{"properties":{"ok":{"const":true,"default":true,"title":"Ok","type":"boolean"},"credits_charged":{"title":"Credits Charged","type":"integer"},"credits_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Remaining"},"cached":{"title":"Cached","type":"boolean"},"cached_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Cached At"},"request_id":{"title":"Request Id","type":"string"},"data":{"$ref":"#/components/schemas/ListPage_RequestLogEntry_"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Has More"},"raw":{"default":null,"title":"Raw"}},"required":["credits_charged","credits_remaining","cached","cached_at","request_id","data"],"title":"SuccessEnvelope[ListPage[RequestLogEntry]]","type":"object"},"SuccessEnvelope_ListPage_Review__":{"properties":{"ok":{"const":true,"default":true,"title":"Ok","type":"boolean"},"credits_charged":{"title":"Credits Charged","type":"integer"},"credits_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Remaining"},"cached":{"title":"Cached","type":"boolean"},"cached_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Cached At"},"request_id":{"title":"Request Id","type":"string"},"data":{"$ref":"#/components/schemas/ListPage_Review_"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Has More"},"raw":{"default":null,"title":"Raw"}},"required":["credits_charged","credits_remaining","cached","cached_at","request_id","data"],"title":"SuccessEnvelope[ListPage[Review]]","type":"object"},"SuccessEnvelope_ListPage_Song__":{"properties":{"ok":{"const":true,"default":true,"title":"Ok","type":"boolean"},"credits_charged":{"title":"Credits Charged","type":"integer"},"credits_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Remaining"},"cached":{"title":"Cached","type":"boolean"},"cached_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Cached At"},"request_id":{"title":"Request Id","type":"string"},"data":{"$ref":"#/components/schemas/ListPage_Song_"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Has More"},"raw":{"default":null,"title":"Raw"}},"required":["credits_charged","credits_remaining","cached","cached_at","request_id","data"],"title":"SuccessEnvelope[ListPage[Song]]","type":"object"},"SuccessEnvelope_ListPage_Suggestion__":{"properties":{"ok":{"const":true,"default":true,"title":"Ok","type":"boolean"},"credits_charged":{"title":"Credits Charged","type":"integer"},"credits_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Remaining"},"cached":{"title":"Cached","type":"boolean"},"cached_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Cached At"},"request_id":{"title":"Request Id","type":"string"},"data":{"$ref":"#/components/schemas/ListPage_Suggestion_"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Has More"},"raw":{"default":null,"title":"Raw"}},"required":["credits_charged","credits_remaining","cached","cached_at","request_id","data"],"title":"SuccessEnvelope[ListPage[Suggestion]]","type":"object"},"SuccessEnvelope_ListPage_UsageStat__":{"properties":{"ok":{"const":true,"default":true,"title":"Ok","type":"boolean"},"credits_charged":{"title":"Credits Charged","type":"integer"},"credits_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Remaining"},"cached":{"title":"Cached","type":"boolean"},"cached_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Cached At"},"request_id":{"title":"Request Id","type":"string"},"data":{"$ref":"#/components/schemas/ListPage_UsageStat_"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Has More"},"raw":{"default":null,"title":"Raw"}},"required":["credits_charged","credits_remaining","cached","cached_at","request_id","data"],"title":"SuccessEnvelope[ListPage[UsageStat]]","type":"object"},"SuccessEnvelope_ListPage_WebhookDelivery__":{"properties":{"ok":{"const":true,"default":true,"title":"Ok","type":"boolean"},"credits_charged":{"title":"Credits Charged","type":"integer"},"credits_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Remaining"},"cached":{"title":"Cached","type":"boolean"},"cached_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Cached At"},"request_id":{"title":"Request Id","type":"string"},"data":{"$ref":"#/components/schemas/ListPage_WebhookDelivery_"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Has More"},"raw":{"default":null,"title":"Raw"}},"required":["credits_charged","credits_remaining","cached","cached_at","request_id","data"],"title":"SuccessEnvelope[ListPage[WebhookDelivery]]","type":"object"},"SuccessEnvelope_LiveStream_":{"properties":{"ok":{"const":true,"default":true,"title":"Ok","type":"boolean"},"credits_charged":{"title":"Credits Charged","type":"integer"},"credits_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Remaining"},"cached":{"title":"Cached","type":"boolean"},"cached_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Cached At"},"request_id":{"title":"Request Id","type":"string"},"data":{"$ref":"#/components/schemas/LiveStream"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Has More"},"raw":{"default":null,"title":"Raw"}},"required":["credits_charged","credits_remaining","cached","cached_at","request_id","data"],"title":"SuccessEnvelope[LiveStream]","type":"object"},"SuccessEnvelope_Monitor_":{"properties":{"ok":{"const":true,"default":true,"title":"Ok","type":"boolean"},"credits_charged":{"title":"Credits Charged","type":"integer"},"credits_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Remaining"},"cached":{"title":"Cached","type":"boolean"},"cached_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Cached At"},"request_id":{"title":"Request Id","type":"string"},"data":{"$ref":"#/components/schemas/Monitor"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Has More"},"raw":{"default":null,"title":"Raw"}},"required":["credits_charged","credits_remaining","cached","cached_at","request_id","data"],"title":"SuccessEnvelope[Monitor]","type":"object"},"SuccessEnvelope_Post_":{"properties":{"ok":{"const":true,"default":true,"title":"Ok","type":"boolean"},"credits_charged":{"title":"Credits Charged","type":"integer"},"credits_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Remaining"},"cached":{"title":"Cached","type":"boolean"},"cached_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Cached At"},"request_id":{"title":"Request Id","type":"string"},"data":{"$ref":"#/components/schemas/Post"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Has More"},"raw":{"default":null,"title":"Raw"}},"required":["credits_charged","credits_remaining","cached","cached_at","request_id","data"],"title":"SuccessEnvelope[Post]","type":"object"},"SuccessEnvelope_Product_":{"properties":{"ok":{"const":true,"default":true,"title":"Ok","type":"boolean"},"credits_charged":{"title":"Credits Charged","type":"integer"},"credits_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Remaining"},"cached":{"title":"Cached","type":"boolean"},"cached_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Cached At"},"request_id":{"title":"Request Id","type":"string"},"data":{"$ref":"#/components/schemas/Product"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Has More"},"raw":{"default":null,"title":"Raw"}},"required":["credits_charged","credits_remaining","cached","cached_at","request_id","data"],"title":"SuccessEnvelope[Product]","type":"object"},"SuccessEnvelope_Profile_":{"properties":{"ok":{"const":true,"default":true,"title":"Ok","type":"boolean"},"credits_charged":{"title":"Credits Charged","type":"integer"},"credits_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Remaining"},"cached":{"title":"Cached","type":"boolean"},"cached_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Cached At"},"request_id":{"title":"Request Id","type":"string"},"data":{"$ref":"#/components/schemas/Profile"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Has More"},"raw":{"default":null,"title":"Raw"}},"required":["credits_charged","credits_remaining","cached","cached_at","request_id","data"],"title":"SuccessEnvelope[Profile]","type":"object"},"SuccessEnvelope_Repo_":{"properties":{"ok":{"const":true,"default":true,"title":"Ok","type":"boolean"},"credits_charged":{"title":"Credits Charged","type":"integer"},"credits_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Remaining"},"cached":{"title":"Cached","type":"boolean"},"cached_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Cached At"},"request_id":{"title":"Request Id","type":"string"},"data":{"$ref":"#/components/schemas/Repo"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Has More"},"raw":{"default":null,"title":"Raw"}},"required":["credits_charged","credits_remaining","cached","cached_at","request_id","data"],"title":"SuccessEnvelope[Repo]","type":"object"},"SuccessEnvelope_Song_":{"properties":{"ok":{"const":true,"default":true,"title":"Ok","type":"boolean"},"credits_charged":{"title":"Credits Charged","type":"integer"},"credits_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Remaining"},"cached":{"title":"Cached","type":"boolean"},"cached_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Cached At"},"request_id":{"title":"Request Id","type":"string"},"data":{"$ref":"#/components/schemas/Song"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Has More"},"raw":{"default":null,"title":"Raw"}},"required":["credits_charged","credits_remaining","cached","cached_at","request_id","data"],"title":"SuccessEnvelope[Song]","type":"object"},"SuccessEnvelope_Transcript_":{"properties":{"ok":{"const":true,"default":true,"title":"Ok","type":"boolean"},"credits_charged":{"title":"Credits Charged","type":"integer"},"credits_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Remaining"},"cached":{"title":"Cached","type":"boolean"},"cached_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Cached At"},"request_id":{"title":"Request Id","type":"string"},"data":{"$ref":"#/components/schemas/Transcript"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Has More"},"raw":{"default":null,"title":"Raw"}},"required":["credits_charged","credits_remaining","cached","cached_at","request_id","data"],"title":"SuccessEnvelope[Transcript]","type":"object"},"SuccessEnvelope_WebhookRedelivery_":{"properties":{"ok":{"const":true,"default":true,"title":"Ok","type":"boolean"},"credits_charged":{"title":"Credits Charged","type":"integer"},"credits_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Remaining"},"cached":{"title":"Cached","type":"boolean"},"cached_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Cached At"},"request_id":{"title":"Request Id","type":"string"},"data":{"$ref":"#/components/schemas/WebhookRedelivery"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Has More"},"raw":{"default":null,"title":"Raw"}},"required":["credits_charged","credits_remaining","cached","cached_at","request_id","data"],"title":"SuccessEnvelope[WebhookRedelivery]","type":"object"},"SuccessEnvelope_WebhookTest_":{"properties":{"ok":{"const":true,"default":true,"title":"Ok","type":"boolean"},"credits_charged":{"title":"Credits Charged","type":"integer"},"credits_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Remaining"},"cached":{"title":"Cached","type":"boolean"},"cached_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Cached At"},"request_id":{"title":"Request Id","type":"string"},"data":{"$ref":"#/components/schemas/WebhookTest"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cursor"},"has_more":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Has More"},"raw":{"default":null,"title":"Raw"}},"required":["credits_charged","credits_remaining","cached","cached_at","request_id","data"],"title":"SuccessEnvelope[WebhookTest]","type":"object"},"Suggestion":{"additionalProperties":false,"description":"One search suggestion or typeahead entry (TikTok, YouTube, Instagram).","properties":{"object":{"const":"suggestion","default":"suggestion","title":"Object","type":"string"},"platform":{"$ref":"#/components/schemas/Platform"},"kind":{"default":"query","enum":["query","channel","user","hashtag","place","product","unknown"],"title":"Kind","type":"string"},"text":{"title":"Text","type":"string"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Id"},"handle":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Handle"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Url"},"image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Image Url"},"verified":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Verified"},"extra":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"title":"Extra"}},"required":["platform","text"],"title":"Suggestion","type":"object"},"Transcript":{"additionalProperties":false,"properties":{"object":{"const":"transcript","default":"transcript","title":"Object","type":"string"},"platform":{"$ref":"#/components/schemas/Platform"},"video_id":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Video Id"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Url"},"language":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Language"},"source":{"enum":["captions","auto_captions","ai"],"title":"Source","type":"string"},"duration_seconds":{"anyOf":[{"type":"number"},{"type":"null"}],"default":null,"title":"Duration Seconds"},"text":{"title":"Text","type":"string"},"segments":{"anyOf":[{"items":{"$ref":"#/components/schemas/TranscriptSegment"},"type":"array"},{"type":"null"}],"default":null,"title":"Segments"},"available_languages":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"default":null,"title":"Available Languages"},"extra":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"title":"Extra"}},"required":["platform","source","text"],"title":"Transcript","type":"object"},"TranscriptSegment":{"additionalProperties":false,"properties":{"start":{"title":"Start","type":"number"},"end":{"anyOf":[{"type":"number"},{"type":"null"}],"default":null,"title":"End"},"text":{"title":"Text","type":"string"}},"required":["start","text"],"title":"TranscriptSegment","type":"object"},"UsageStat":{"additionalProperties":false,"description":"Aggregated usage: one day (`date` set) or one endpoint (`endpoint` set).","properties":{"object":{"const":"usage_stat","default":"usage_stat","title":"Object","type":"string"},"date":{"anyOf":[{"format":"date","type":"string"},{"type":"null"}],"default":null,"title":"Date"},"endpoint":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Endpoint"},"requests":{"title":"Requests","type":"integer"},"credits_charged":{"title":"Credits Charged","type":"integer"}},"required":["requests","credits_charged"],"title":"UsageStat","type":"object"},"WebhookDelivery":{"additionalProperties":false,"description":"One delivery attempt of a monitor event.","properties":{"object":{"const":"webhook_delivery","default":"webhook_delivery","title":"Object","type":"string"},"event_id":{"title":"Event Id","type":"string"},"monitor_id":{"title":"Monitor Id","type":"string"},"attempt":{"title":"Attempt","type":"integer"},"status_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"title":"Status Code"},"ok":{"title":"Ok","type":"boolean"},"dead_letter":{"title":"Dead Letter","type":"boolean"},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Error"},"created_at":{"format":"date-time","title":"Created At","type":"string"}},"required":["event_id","monitor_id","attempt","ok","dead_letter","created_at"],"title":"WebhookDelivery","type":"object"},"WebhookRedelivery":{"additionalProperties":false,"properties":{"object":{"const":"webhook_redelivery","default":"webhook_redelivery","title":"Object","type":"string"},"event_id":{"title":"Event Id","type":"string"},"queued":{"title":"Queued","type":"boolean"},"previous_state":{"enum":["pending","retrying","dead"],"title":"Previous State","type":"string"}},"required":["event_id","queued","previous_state"],"title":"WebhookRedelivery","type":"object"},"WebhookTest":{"additionalProperties":false,"description":"What the receiver answered to a signed test event (\"type\": \"test\").","properties":{"object":{"const":"webhook_test","default":"webhook_test","title":"Object","type":"string"},"monitor_id":{"title":"Monitor Id","type":"string"},"delivered":{"title":"Delivered","type":"boolean"},"status_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"title":"Status Code"},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Error"}},"required":["monitor_id","delivered"],"title":"WebhookTest","type":"object"}}}}