{"id":17091377,"url":"https://github.com/jhurliman/node-echoprint-server","last_synced_at":"2025-07-01T13:38:54.195Z","repository":{"id":2544387,"uuid":"3522156","full_name":"jhurliman/node-echoprint-server","owner":"jhurliman","description":"A node.js implementation of the Echoprint music identification server","archived":false,"fork":false,"pushed_at":"2013-05-27T21:13:43.000Z","size":231,"stargazers_count":74,"open_issues_count":11,"forks_count":36,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-26T16:38:59.303Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"progrium/rootbuilder","license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jhurliman.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":"2012-02-23T04:05:58.000Z","updated_at":"2022-09-27T00:13:43.000Z","dependencies_parsed_at":"2022-08-20T14:01:14.687Z","dependency_job_id":null,"html_url":"https://github.com/jhurliman/node-echoprint-server","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/jhurliman%2Fnode-echoprint-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jhurliman%2Fnode-echoprint-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jhurliman%2Fnode-echoprint-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jhurliman%2Fnode-echoprint-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jhurliman","download_url":"https://codeload.github.com/jhurliman/node-echoprint-server/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248642308,"owners_count":21138350,"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":[],"created_at":"2024-10-14T13:58:25.674Z","updated_at":"2025-04-12T22:34:45.006Z","avatar_url":"https://github.com/jhurliman.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# node-echoprint-server #\n\nA node.js music identification server that is compatible with the \n[Echoprint](http://echoprint.me/) music fingerprinting client. This server is \nbased on the original \n[echoprint-server](https://github.com/echonest/echoprint-server) but attempts \nto improve on ease of installation, speed, matching accuracy, and ease of \ndevelopment/debugging.\n\n## Dependencies ##\n\n* [node.js](http://nodejs.org/) - Tested with 0.6.10\n* [MySQL](http://mysql.com/) - Tested with 5.5.20\n\nTo generate audio fingerprints you will need the \n[echoprint-codegen](https://github.com/echonest/echoprint-codegen) client.\n\n## Installation ##\n\nClone this repository, enter the `node-echoprint-server` directory and run \n`npm install` to fetch the required dependencies. Import the `mysql.sql` file \ninto your MySQL database. Next, copy `config.local.js.orig` to \n`config.local.js` and modify it to suit your environment. Make sure the \ndatabase settings point to the MySQL database you just imported. Finally, run \n`node index.js` to start the server.\n\n## Usage ##\n\nThe server will listen on the port configured in `config.local.js` and exposes \ntwo API endpoints.\n\n### POST /ingest\n\nAdds a new music fingerprint to the database if the given fingerprint is \nunique, otherwise the existing track information is returned.\n\nRequired fields:\n\n* `code` - The code string output by echoprint-codegen\n* `version` - metadata.version field output by echoprint-codegen\n* `length` - Length in seconds of the track. duration field output by \n   echoprint-codegen\n\nOptional fields:\n\n* `track` - Name of the track\n* `artist` - Track artist\n\nThe response is a JSON object containing `track_id`, `track`, `artist_id`, \n`artist` on success or `error` string on failure.\n \n### GET /query?code=...\u0026version=...\n\nQueries for a track matching the given fingerprint. `code` and `version` \nquery parameters are both required. The response is a JSON object \ncontaining a `success` boolean, `status` string, `match` object on \nsuccessful match, or `error` string if something went wrong.\n\n### GET /debug\n\nThe /debug endpoint can be visited in a browser and provides a human-friendly \nway of querying for a match and observing results. Here is a screenshot of the \ndebug interface in action:\n\n![](https://github.com/jhurliman/node-echoprint-server/raw/master/docs/node-echoprint-debug01.png)\n\n## Sponsors ##\n\nThis server has been released as open source by \n[John Hurliman](http://jhurliman.org/) at [cull.tv](http://cull.tv).\n\n## License ##\n\nUses code from \n[echoprint-server](https://github.com/echonest/echoprint-server), which is \nreleased by The Echo Nest Corporation under the \n[Apache 2 License](https://github.com/echonest/echoprint-server/blob/master/LICENSE).\n\n(The MIT License)\n\nCopyright (c) 2012 Cull TV, Inc. \u0026lt;jhurliman@cull.tv\u0026gt;\n\nPermission is hereby granted, free of charge, to any person obtaining\na copy of this software and associated documentation files (the\n'Software'), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to\nthe following conditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\nIN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY\nCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\nTORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE\nSOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjhurliman%2Fnode-echoprint-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjhurliman%2Fnode-echoprint-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjhurliman%2Fnode-echoprint-server/lists"}