{"id":17458118,"url":"https://github.com/pocesar/node-nxt-api","last_synced_at":"2025-03-21T03:33:31.894Z","repository":{"id":20260294,"uuid":"23533179","full_name":"pocesar/node-nxt-api","owner":"pocesar","description":"API request for NXT crypto","archived":false,"fork":false,"pushed_at":"2015-03-24T03:22:49.000Z","size":315,"stargazers_count":6,"open_issues_count":3,"forks_count":7,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-10-18T06:28:12.631Z","etag":null,"topics":[],"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/pocesar.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}},"created_at":"2014-09-01T06:45:33.000Z","updated_at":"2020-10-28T09:19:58.000Z","dependencies_parsed_at":"2022-09-01T10:51:36.031Z","dependency_job_id":null,"html_url":"https://github.com/pocesar/node-nxt-api","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pocesar%2Fnode-nxt-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pocesar%2Fnode-nxt-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pocesar%2Fnode-nxt-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pocesar%2Fnode-nxt-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pocesar","download_url":"https://codeload.github.com/pocesar/node-nxt-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221811374,"owners_count":16884305,"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-18T03:54:48.704Z","updated_at":"2024-10-28T09:17:17.582Z","avatar_url":"https://github.com/pocesar.png","language":"JavaScript","readme":"[![Build Status](https://travis-ci.org/pocesar/node-nxt-api.svg?branch=master)](https://travis-ci.org/pocesar/node-nxt-api)\n[![Coverage Status](https://img.shields.io/coveralls/pocesar/node-nxt-api.svg)](https://coveralls.io/r/pocesar/node-nxt-api?branch=master)\n\nNXT API\n============\n\nAPI request wrapper for [NXT crypto](http://wiki.nxtcrypto.org/wiki/Nxt_API) for Node.js and the browser.\nIt just has all the currently public API methods for NXT along side with a dual API Promise/Callback based interface.\n\nPlus it's created using Typescript, which should ensure the proper parameters for each API call.\n\n## Install\n\nFor node.js\n\n```\nnpm -g install typescript\nnpm install nxt-api\n```\n\nFor the browser\n\n```\nbower install nxt-api\n```\n\n## Usage\n\nIn Node.js:\n\n```javascript\nvar NXT = require('nxt-api');\n\n// start your NRS client first\nvar API = new NXT.API('http://127.0.0.1:6876');\n\nAPI.getNextBlockGenerators().then(function (answer) {\n    console.log(answer);\n});\n\nAPI.rsConvert({ account: 'x' }).then(function (answer) {\n    // should error\n}, function (error) {\n    console.log(error);\n});\n```\n\nIn the browser (needs to have `nxt.apiServerCORS=true` in your NXT config file, otherwise you need to access it from same port and hostname):\n\n```html\n\u003cscript src=\"nxt-api.js\"\u003e\u003c/script\u003e\n\u003cscript\u003e\n    var instance = new NXT.API('http://127.0.0.1:7876');\n\n    instance.getNextBlockGenerators().then(function(answer){\n        console.log(answer);\n    });\n\u003c/script\u003e\n```\n\n## Example\n\nStart the NRS in testNet mode, then run\n\n```\nnpm run example\n```\n\n## TODO\n\n- Missing JSDocs for most of the functions\n\n## Support\n\n* `BTC: 1PskTzQjmzqB2boz67AXsv4C5YNWN4xmhu`\n* `NXT: NXT-7TJT-8NS2-8QBS-5Y89X`\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpocesar%2Fnode-nxt-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpocesar%2Fnode-nxt-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpocesar%2Fnode-nxt-api/lists"}