{"id":16357007,"url":"https://github.com/zbone3/node-icobench","last_synced_at":"2025-03-23T01:31:45.867Z","repository":{"id":99056028,"uuid":"120764974","full_name":"zbone3/node-icobench","owner":"zbone3","description":"A simple Node.js  wrapper for the ICOBench.com API","archived":false,"fork":false,"pushed_at":"2022-04-04T11:53:11.000Z","size":13,"stargazers_count":9,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-18T08:57:20.002Z","etag":null,"topics":["api","cryptocurrencies","ico","icobench","node-wrapper","nodejs"],"latest_commit_sha":null,"homepage":null,"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/zbone3.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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":"2018-02-08T13:29:43.000Z","updated_at":"2022-04-04T11:53:14.000Z","dependencies_parsed_at":null,"dependency_job_id":"a68bc235-78f3-4ed5-97da-62dc997f3e2b","html_url":"https://github.com/zbone3/node-icobench","commit_stats":{"total_commits":17,"total_committers":2,"mean_commits":8.5,"dds":"0.17647058823529416","last_synced_commit":"2eee842e1df747f83a2bac7c565fd9daae0bcb45"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zbone3%2Fnode-icobench","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zbone3%2Fnode-icobench/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zbone3%2Fnode-icobench/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zbone3%2Fnode-icobench/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zbone3","download_url":"https://codeload.github.com/zbone3/node-icobench/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245044027,"owners_count":20551870,"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":["api","cryptocurrencies","ico","icobench","node-wrapper","nodejs"],"created_at":"2024-10-11T01:44:43.381Z","updated_at":"2025-03-23T01:31:45.861Z","avatar_url":"https://github.com/zbone3.png","language":"JavaScript","readme":"# node-icobench\nA simple Node.js wrapper for the ICOBench.com API\n\n\n## Prerequisites\nYou need to request access to ICOBench's API by following next steps:\n1. Register a new account [here](https://icobench.com/register).\n2. Request the API key [here](https://icobench.com/developers).\n\n\n## Installation\n`npm install node-icobench`\n\n\n## Usage\n### Initializing\n ```js \n \nconst ICOBench = require('node-icobench');\n\n// Use the public and private keys you received on icobench.com\nconst pubKey = '1234';\nconst prikey = 'abcd';\n\nlet icobench = new ICOBench(pubKey, prikey);\n```\n\n### API Examples\nThe wrapper returns a promise for all request types, so you can use `Promise.then()` or `async/await` to get the results\n```js\n// Get all ICOs\nicobench.icos.all();\n\n// Get page 32 from all ICOs results\nicobench.icos.all({page: 32});\n\n// Get registered ICOBench members\nicobench.people.registered();\n\n// Get trending ICOs\nicobench.icos.trending();\n\n// Get more information on an ICO\nicobench.ico.profile({ico: 678});\n\n\n\n// Use with Promise.then()\n\nicobench.people.all().then(function(response) {\n  // print number of people\n  console.log(response.people);\n  \n  // iterate all people\n  for (let item of response.results) {\n    // print person name\n    console.log(item.name);\n  }\n});\n\n\n// Use with async function \n\n(async function() {\n  let stats =  await icobench.stats();\n  // Print number of ICOs\n  console.log(stats.icos);\n})();\n\n\n```\n\n### API Reference\nThis table maps the original API to the wrapper functions.  \nPlease note that all parameters are passed as an `Object` to the function.  \nExample: get page 2 of all icos: `icobench.icos.all({page: 2})`\n\n| Original API        | Wrapper                   | Parameters             |\n|---------------------|---------------------------|------------------------|\n| /icos/all           | icobench.icos.all         | optional               |\n| /icos/filters       | icobench.icos.filters     | optional               |\n| /icos/trending      | icobench.icos.trending    | optional               |\n| /icos/ratings       | icobench.icos.ratings     | optional               |\n| /ico/{id \u0026#124; url}| icobench.ico.profile      | Object: {ico: [ICO ID]}|\n| /people/{all}       | icobench.people.all       | optional               |\n| /people/{expert}    | icobench.people.expert    | optional               |\n| /people/{registered}| icobench.people.registered| optional               |\n| /other/stats        | icobench.stats            | optional               |\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzbone3%2Fnode-icobench","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzbone3%2Fnode-icobench","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzbone3%2Fnode-icobench/lists"}