{"id":15146344,"url":"https://github.com/iammordaty/soundcloud-api-client","last_synced_at":"2025-09-29T15:31:21.678Z","repository":{"id":57366436,"uuid":"157529466","full_name":"iammordaty/soundcloud-api-client","owner":"iammordaty","description":":stuck_out_tongue_winking_eye: Dead simple, promise-based, Node.js library for interacting with the SoundCloud public API","archived":true,"fork":false,"pushed_at":"2018-11-20T18:47:20.000Z","size":30,"stargazers_count":12,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-09-23T04:42:11.508Z","etag":null,"topics":["node-js","node-module","request-promise","soundcloud","soundcloud-api"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/soundcloud-api-client","language":"JavaScript","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/iammordaty.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}},"created_at":"2018-11-14T10:09:47.000Z","updated_at":"2023-01-27T20:44:38.000Z","dependencies_parsed_at":"2022-08-23T19:40:44.970Z","dependency_job_id":null,"html_url":"https://github.com/iammordaty/soundcloud-api-client","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iammordaty%2Fsoundcloud-api-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iammordaty%2Fsoundcloud-api-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iammordaty%2Fsoundcloud-api-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iammordaty%2Fsoundcloud-api-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/iammordaty","download_url":"https://codeload.github.com/iammordaty/soundcloud-api-client/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219874605,"owners_count":16554600,"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":["node-js","node-module","request-promise","soundcloud","soundcloud-api"],"created_at":"2024-09-26T12:01:21.877Z","updated_at":"2025-09-29T15:31:21.367Z","avatar_url":"https://github.com/iammordaty.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# soundcloud-api-client\n\nNode.js module for the [SoundCloud API](http://soundcloud.com). See full API documentation [here](https://developers.soundcloud.com/docs/api/reference).\n\n## Table of Contents\n\n- [Getting Started](#getting-started)\n  - [Installation](#installation)\n  - [Usage](#usage)\n  - [API](#api)\n- [Examples](#examples)\n- [Further information](#further-information)\n- [License](#license)\n\n## Getting Started\n\nIn order to use the module, you need to acquire a `client_id` for your application, which can be obtained from [SoundCloud for Developers page](https://developers.soundcloud.com/).\n\n### Installation\n\nThis library can be installed through npm:\n\n```\n$ npm install --save soundcloud-api-client\n```\n\n### Usage\n\nThe following example shows how to initialize the library and perform a search request with sample criteria.\n\n```js\nconst SoundCloud = require('soundcloud-api-client');\n\nconst client_id = 'your-client-id';\nconst soundcloud = new SoundCloud({ client_id });\n\nconst q = 'live mix';\nconst genres = [ 'house', 'tech-house', 'techno' ].join(',');\n\nsoundcloud.get('/tracks', { q, genres })\n    .then(tracks =\u003e /* process tracks */)\n    .catch(e =\u003e /* handle error */);\n```\n\nThe next example demonstrates how to fetch 10 most recent user comments.\n\n```js\nconst user = 'user-name-or-id'; // user id is necessary to fetch user tracks\nconst offset = 0;\nconst limit = 10;\n\nsoundcloud.get(`/users/${user}/comments`, { offset, limit })\n    .then(comments =\u003e /* process comments */)\n    .catch(e =\u003e /* handle error */);\n```\n\n### API\n\nThe main export of this library is the SoundCloud class.\n\n#### SoundCloud\n\nThe SoundCloud constructor accepts a `config` object which may contain one or more of the following options:\n\n* `client_id` – Your client Id (required)\n* `hostname` – Override the default host API calls are issued to\n\n#### get\n\nPerforms a get request. The method takes two parameters:\n\n* `pathname` – Request pathname or URL (required)\n* `params` – Request parameters (see API documentation page for possible values)\n\n#### download\n\nSaves the specified resource to the local file system. The method takes two parameters:\n\n* `pathname` – Remote pathname or URL (required)\n* `filename` – Local pathname (required)\n\n## Examples\n\nVarious examples can be found in the [examples directory on GitHub.com](https://github.com/iammordaty/soundcloud-api-client/tree/master/examples). Also have a look at the [RunKit](https://npm.runkit.com/soundcloud-api-client), where you can test this library.\n\n## Further information\n\n - [SoundCloud HTTP API Reference](https://developers.soundcloud.com/docs/api/reference)\n\n## License\n\nsoundcloud-api-client is licensed under the MIT License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiammordaty%2Fsoundcloud-api-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fiammordaty%2Fsoundcloud-api-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiammordaty%2Fsoundcloud-api-client/lists"}