EveryData platform API
Twitch API
Twitch separates Twitch channels, live streams, clips, top streams, and game categories across 6 documented actions (`search`, `profile`, `clips`), keeping discovery and object-detail contracts distinct.
Start with `search` using `keyword` for matching public results, then move to `profile` using `username` for the selected Twitch record so the two result shapes stay distinct.
- Endpoint
- POST /api/v1/social
- Capabilities
- 6
- Per 1,000
- $1.389
Available capabilities
Compare the Twitch actions by required input, returned data, and price. Use the action identifier exactly as shown in your request.
| Action | Required | Optional | Delivery | Limit | Per 1,000 | Response fields |
|---|---|---|---|---|---|---|
searchSearch Search public results on Twitch. Accepts these parameters: | keyword | — | Sync delivery | Catalog values: defaultLimit=10, maxLimit=30. A limit can control pages or per-parent expansion for some actions, so it is not always a final row count. | $1.39 per 1,000 requests | user_id · username · display_name · bio · url · avatar_url · banner_url · follower_count · is_partner · is_affiliate · is_live · current_viewers · stream_title · current_game · stream_started_at · last_broadcast_title · last_broadcast_game · last_broadcast_at · created_at |
profileProfiles Retrieve public profile details from Twitch. Accepts these parameters: | username | include_clips, include_videos | Sync delivery | — | $1.39 per 1,000 requests | user_id · username · display_name · bio · url · avatar_url · banner_url · follower_count · is_partner · is_affiliate · is_live · current_viewers · stream_title · current_game · stream_started_at · last_broadcast_title · last_broadcast_game · last_broadcast_at · created_at |
clipsClips Use the | username | period | Sync delivery | Catalog values: defaultLimit=10, maxLimit=30. A limit can control pages or per-parent expansion for some actions, so it is not always a final row count. | $1.39 per 1,000 requests | id · title · url · view_count · duration_seconds · game · channel_username · channel_name · curator_username · curator_name · thumbnail_url · created_at · platform |
streamsStreams Use the | game | keyword | Sync delivery | Catalog values: defaultLimit=10, maxLimit=30. A limit can control pages or per-parent expansion for some actions, so it is not always a final row count. | $1.39 per 1,000 requests | stream_id · username · display_name · follower_count · title · viewer_count · game · started_at · url · avatar_url · platform |
top_streamsTop streams Use the | — | Sync delivery | Catalog values: defaultLimit=10, maxLimit=30. A limit can control pages or per-parent expansion for some actions, so it is not always a final row count. | $1.39 per 1,000 requests | stream_id · username · display_name · follower_count · title · viewer_count · game · started_at · url · avatar_url · platform | |
top_gamesTop games Use the | — | Sync delivery | Catalog values: defaultLimit=10, maxLimit=200. A limit can control pages or per-parent expansion for some actions, so it is not always a final row count. | $1.39 per 1,000 requests | id · name · viewer_count · broadcaster_count · box_art_url · url · platform |
What does each Twitch action accept?
Each answer below pairs one callable action with its real inputs. Parameter meanings and allowed values are action-specific; a familiar name does not carry the same meaning across every platform.
Official sources are linked only to clarify the platform term beside them. They do not imply platform authorization or endorsement, and they do not add official-site features to the EveryInfra API contract.
What do the Twitch search parameters mean?
Search public results on Twitch. Accepts these parameters: keyword. Returns these fields: is_partner, last_broadcast_at, is_live, and stream_started_at.
keywordRequired- Channel keyword for search. The streams endpoint requires an exact game or category name via game, rather than arbitrary stream title keywords.
What do the Twitch profile parameters mean?
Retrieve public profile details from Twitch. Accepts these parameters: include_clips, include_videos, and username. Returns these fields: username, stream_title, current_game, and is_affiliate.
usernameRequired- Twitch channel login short name for profile or clips, optionally prefixed with @, without parsing full twitch.tv URLs.Twitch: Login Names, Display Names, and Broadcaster TypesOfficial Twitch documentation separately defines login, display_name, and broadcaster_type. Here, username should use the channel short name and not treat the display name or Partner/Affiliate type as a login credential; other parameters supported by official user queries are not automatically added to this API.Checked
include_clipsOptional- Boolean value defaulting to true indicating whether the profile response includes curated clip information. Its time window differs from the standalone clips endpoint.
include_videosOptional- Boolean value defaulting to true indicating whether the profile response includes recent video archive information. Set to false to omit this section; do not pass the string "false".
What do the Twitch clips parameters mean?
Use the clips action on Twitch. Accepts these parameters: username and period. Returns these fields: view_count, curator_name, title, and channel_name.
usernameRequired- Twitch channel login short name for profile or clips, optionally prefixed with @, without parsing full twitch.tv URLs.
periodOptional- Time window for clips: LAST_DAY for the past day, LAST_WEEK for the past week (default), LAST_MONTH for the past month, or ALL_TIME for unrestricted. Values are case-insensitive, and invalid values fall back to LAST_WEEK.Twitch: Clip Creators, Source Channels, and View CountsOfficial Clip documentation separates broadcaster from creator, defines view_count as the clip view count, and defines duration in seconds. This only verifies terminology and does not replicate official start/end dates, cursors, or clip creation parameters.Checked
What do the Twitch streams parameters mean?
Use the streams action on Twitch. Accepts these parameters: game and keyword. Returns these fields: follower_count, avatar_url, viewer_count, and started_at.
gameRequired- Exact Twitch category name for streams, such as Just Chatting. Returns channels currently streaming in that category, not historical video archives of the game.Twitch: Live Stream Categories and Current Viewer CountsOfficial live stream documentation distinguishes categories, channels, and current live streams, defining viewer_count as the number of users currently watching the stream. It is not a Clip view count, follower count, or historical total view count; the official game_id parameter does not replace the category name required by this page.Checked
keywordOptional- Channel keyword for search. The streams endpoint requires an exact game or category name via game, rather than arbitrary stream title keywords.
What do the Twitch top_streams parameters mean?
Use the top_streams action on Twitch. Requires no parameters. Returns these fields: follower_count, stream_id, username, and started_at.
This action has no business parameters. Send only the platform and action identifiers.
What do the Twitch top_games parameters mean?
Use the top_games action on Twitch. Requires no parameters. Returns these fields: box_art_url, broadcaster_count, name, and viewer_count.
This action has no business parameters. Send only the platform and action identifiers.
How to use the Twitch API
- 01Read the public catalog and choose a platform action.
- 02Send the platform, action, and required parameters to POST /api/v1/social.
- 03Handle a synchronous result or poll the returned job ID when the selected action is asynchronous.
- 04Store the structured response fields needed by your application.
curl -X POST https://api.everyinfra.com/api/v1/social \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"platform":"twitch","action":"search","params":{"keyword":"<keyword>"}}'
Twitch API questions
What can I retrieve with the Twitch API?
Set platform to twitch. The current catalog lists search, profiles, clips, streams, top streams, and more. These action names identify different Twitch objects or views; they are not interchangeable search modes.
Which input starts a Twitch `search` request?
Channel keyword for search. The streams endpoint requires an exact game or category name via game, rather than arbitrary stream title keywords. Send it as keyword inside params.
Which fields can Twitch `search` return?
Its declared schema includes user_id, username, display_name, and bio. A declared field can still be absent from an individual source record, and every other action has its own field list.
Does every Twitch action return immediately?
No assumption is needed: this page labels each action's delivery mode. The current catalog contains sync delivery; poll a returned job ID only for an action labeled asynchronous.