{"id":39154175,"url":"https://github.com/c4ldas/streamelements-api","last_synced_at":"2026-01-17T21:44:59.398Z","repository":{"id":269368084,"uuid":"907194542","full_name":"c4ldas/streamelements-api","owner":"c4ldas","description":"Unofficial StreamElements API documentation","archived":false,"fork":false,"pushed_at":"2025-10-27T19:23:29.000Z","size":3354,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-27T21:11:28.291Z","etag":null,"topics":["api","endpoints","streamelements"],"latest_commit_sha":null,"homepage":"https://c4ldas.github.io/streamelements-api/","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/c4ldas.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-12-23T03:38:42.000Z","updated_at":"2025-10-27T19:23:33.000Z","dependencies_parsed_at":"2025-01-06T15:28:48.573Z","dependency_job_id":"1a430181-d732-48b6-9343-055cfb639da9","html_url":"https://github.com/c4ldas/streamelements-api","commit_stats":null,"previous_names":["c4ldas/streamelements-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/c4ldas/streamelements-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/c4ldas%2Fstreamelements-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/c4ldas%2Fstreamelements-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/c4ldas%2Fstreamelements-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/c4ldas%2Fstreamelements-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/c4ldas","download_url":"https://codeload.github.com/c4ldas/streamelements-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/c4ldas%2Fstreamelements-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28518679,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-17T18:55:29.170Z","status":"ssl_error","status_checked_at":"2026-01-17T18:55:03.375Z","response_time":85,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","endpoints","streamelements"],"created_at":"2026-01-17T21:44:59.257Z","updated_at":"2026-01-17T21:44:59.328Z","avatar_url":"https://github.com/c4ldas.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"## What is that?\n\nHere's an updated list of Streamelements API endpoints, filling in the missing details and fixing mistakes in the official docs.\n\nThe endpoint list is only for `https://api.streamelements.com/kappa/{v2|v3}`, which means `https://kvstore.streamelements.com/` subdomain is not included.\n\nI also added in a separated page some basic info for StreamElements socket.io and event objects for custom widgets `onEventReceived` listener.\n\n## Filling the gaps\n\nI reviewed all Streamelements API endpoints and created my own api.yaml file because the official API documentation is quite outdated.\n\nSome endpoints were updated, added body and response examples, some had the query parameters fixed, and others moved to `wonky - not working` folder. As the name suggests, these are endpoints that don't work as expected or lack enough information to use properly. These ones are also marked as `deprecated` for clarity.\n\nEvery operation now includes response examples and, where needed, body examples with some explanations to make things clearer.\n\n## Live page\n\nYou can check out all the endpoints and even test them on the live page:\n\n**https://c4ldas.github.io/streamelements-api**\n\nIf you have suggestions or ideas for improvements, feel free to share them!\n\n## Official documentation\n\nThe official Streamelements API documentation is hosted on their [developer site](https://dev.streamelements.com).\n\nUnfortunately, many endpoints are missing, have incorrect body data, or lack sufficient details.\n\n## Improvements\n\nIf you spot any errors or think something could be improved, please let me know!\nAlso, if an endpoint doesn't make sense or isn't clear enough, that's a sign it needs more explanation — don't hesitate to reach out with your questions.\n\n## Notes\n\nJust a heads-up: I don't have access to Streamelements' servers or backend, so I can't fix any issues with the actual endpoint results. This repository is all about documenting the endpoints I've found so far in a way that's easier for everyone to use.\n\n## Preview\n\n![image](https://github.com/user-attachments/assets/12fd5486-a4fc-424f-acca-803ddb81d111)\n\n\n## Pending list\n\n### Install overlay by overlay sharing id\n\n    `https://api.streamelements.com/kappa/v2/overlays/\u003cDESTINATION_ACCOUNT_ID\u003e/share`\n\n    Method: POST\n\n    Payload:\n    ```json\n    { \n      \"overlayId\": \"6326954e94138e6d0bcfb5ff\" \n    } \n    ```\n    **OBS:**\n\n    The original owner must have overlay sharing permissions set in `/channels/me` -\u003e `ab[\"share-overlay\"] = 1`\n\n    It is the same as going to this page:\n    `https://streamelements.com/dashboard/overlays/share/\u003cOVERLAY_ID\u003e`\n\n\n### Request to close account\n\n    `https://api.streamelements.com/kappa/v2/users/close`\n\n    Method: POST\n\n    Payload:\n    ```json\n    {\n      \"email\": \"email@example.com\", // account e-mail\n      \"keepOutreaching\": false, // Stay informed about future partnership opportunities?\n      \"message\": \"I created the account by mistake\", // Reason to close account\n      \"token\": \"\u003cJWT_TOKEN\u003e\", // JWT token\n      \"username\": \"username\" // account username\n    }\n    ```\n\n    Response:\n    ```\n    PENDING RESPONSE EXAMPLE\n    ```\n\n    **OBS:**\n\n    It is the same as going to this page: `https://streamelements.com/dashboard/account/security` -\u003e Close My Account\n\n### Delete media files uploaded to account\n\n    `https://api.streamelements.com/kappa/v2/uploads/\u003cACCOUNT_ID\u003e/\u003cMEDIA_ID\u003e`\n    \n    Method: DELETE\n\n    Payload: \n    ```json\n    {}\n    ```\n\n    Response: \n    ```json\n    {\n      \"message\": \"Resource was successfully removed\",\n      \"asset\": {\n        \"_id\": \"6314baca530249c9d5da8fea\",\n        \"deleted\": true,\n        \"channel\": \"5f2de5dd9a474a2c2aaaaaaa\",\n        \"uuid\": \"7539c9a2-47e1-4db6-a8cd-42742dd22473.png\",\n        \"name\": \"img103.png\",\n        \"size\": 4055645,\n        \"url\": \"https://cdn.streamelements.com/uploads/7539c9a2-47e1-4db6-a8cd-42742dd22473.png\",\n        \"type\": \"image/png\",\n        \"createdAt\": \"2022-09-04T14:48:42.220Z\",\n        \"updatedAt\": \"2025-08-01T17:29:13.116Z\"\n      }\n    }\n    ```\n\n### Add new media file to account\n\n    `https://api.streamelements.com/kappa/v2/uploads/\u003cACCOUNT_ID\u003e`\n\n    Method: POST\n\n    Payload: form data (binary)\n\n    Response:\n    ```json\n    {\n      \"channel\": \"5f2de5dd9a474a2c2aaaaaaa\",\n      \"uuid\": \"01k1kb5877k429dq4vmm6qvr1t.png\",\n      \"size\": 35611,\n      \"name\": \"screenshot.png\",\n      \"type\": \"image/png\",\n      \"url\": \"https://cdn.streamelements.com/uploads/01k1kb5877k429dq4vmm6qvr1t.png\",\n      \"deleted\": false,\n      \"_id\": \"688cfa87fe85e796593236c7\",\n      \"createdAt\": \"2025-08-01T17:33:59.477Z\",\n      \"updatedAt\": \"2025-08-01T17:33:59.477Z\"\n    }\n    ```\n\n    **OBS:**\n\n    Payload example here: `https://discord.com/channels/141203863863558144/259680142459142144/1154393562398605432`","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fc4ldas%2Fstreamelements-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fc4ldas%2Fstreamelements-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fc4ldas%2Fstreamelements-api/lists"}