{"id":18895644,"url":"https://github.com/binance/websocket-demo","last_synced_at":"2025-04-15T01:13:51.717Z","repository":{"id":43123967,"uuid":"364858482","full_name":"binance/websocket-demo","owner":"binance","description":"Live demo site for subscribing to websocket server","archived":false,"fork":false,"pushed_at":"2023-08-28T00:33:53.000Z","size":6611,"stargazers_count":26,"open_issues_count":0,"forks_count":12,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-04-15T01:13:45.803Z","etag":null,"topics":["binance","demo","live","websocket"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/binance.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"contributing.md","funding":null,"license":"LICENSE","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}},"created_at":"2021-05-06T09:38:31.000Z","updated_at":"2025-01-12T07:57:10.000Z","dependencies_parsed_at":"2024-11-08T08:30:40.441Z","dependency_job_id":"aac521c2-820b-422b-9df4-d4c32deb3951","html_url":"https://github.com/binance/websocket-demo","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/binance%2Fwebsocket-demo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/binance%2Fwebsocket-demo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/binance%2Fwebsocket-demo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/binance%2Fwebsocket-demo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/binance","download_url":"https://codeload.github.com/binance/websocket-demo/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248986315,"owners_count":21194025,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["binance","demo","live","websocket"],"created_at":"2024-11-08T08:29:13.254Z","updated_at":"2025-04-15T01:13:51.697Z","avatar_url":"https://github.com/binance.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Websocket Demo [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\n![img](https://imgur.com/LzSD4nG.png[/img] 'init screen')\n\nThis web app is developed to simplify the binance websocket stream testing process. By utilizing the interface, the user can check on multiple streams at a time without knowing the parameters. Since this app is designed for testing purpose instead of the real subscription tool, **_all the subscribed streams will be unsubscribed in 5 sec._**\n\nThe left hand side of the screen has 2 parts. The upper is for user stream subscription. The user can select one of the user streams to subscribe given the valid listen key generated based on the api key. The lower is the market stream selection area. The user can only select the streams under the same data source. That is, once the user select a spot market stream, to select from other source, such as coin-m futures stream, is not allowed.\n\n**Note: Some of the symbols are only available in PRODUCTION.**\n\n## Demo Site\n\n- [Current Deployed Page](https://binance.github.io/websocket-demo)\n\n## Usage\n\n### Initialize Your Local Environment\n\n1. Download the repo\n\n2. Turn on the terminal and execute the following commands\n\n   ```\n   $ cd \u003cyour project directory\u003e\n   $ yarn install\n   $ yarn start\n   ```\n\n3. Open your browser and access `localhost:3000`\n\n### Subscribe the User Data Stream\n\n![img](https://i.imgur.com/pMo5t3P.png[/img] 'user data stream')\n\n1. Use RESTful API to generate the listen key and paste the key to the \"Listen key\" input box. (If you don't know how to generate the key, please check the API document in \"Reference\" section below.)\n2. Select the data source from the drop-down list\n3. Click the corresponding subscribe button.\n\n### Subscribe Market Streams\n\n![img](https://i.imgur.com/dTiRzVh.png[/img] 'market streams')\n\n1. Select the data source from the market stream section\n2. Select the stream(s) to subscribe from the drop-down list. If there is any parameter has to be settled, a modal with drop-down list(s) will show up.\n3. Click the testnet or production subscribe button.\n\n## Available Scripts\n\nIn the project directory, you can run:\n\n#### `yarn start`\n\nRuns the app in the development mode.\\\nOpen [http://localhost:3000](http://localhost:3000) to view it in the browser.\n\nThe page will reload if you make edits.\\\nYou will also see any lint errors in the console.\n\n#### `yarn test` [TODO]\n\nLaunches the test runner in the interactive watch mode.\\\nSee the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.\n\n#### `yarn build`\n\nBuilds the app for production to the `build` folder.\\\nIt correctly bundles React in production mode and optimizes the build for the best performance.\n\nThe build is minified and the filenames include the hashes.\\\nYour app is ready to be deployed!\n\nSee the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.\n\n#### `yarn pretty-quick`\n\nRuns the code formatter. This command is also hooked with the pre-commit.\n\n#### `yarn storybook`\n\nRuns the storybook for component overview.\\\nOpen [http://localhost:6006](http://localhost:6006) to view it in the browser.\n\n#### `yarn build-storybook`\n\nBuilds Storybook as a static web application.\n\n## Reference\n\n- [Binance API doc](https://binance-docs.github.io/apidocs/spot/en/#websocket-market-streams)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbinance%2Fwebsocket-demo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbinance%2Fwebsocket-demo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbinance%2Fwebsocket-demo/lists"}