{"id":24290605,"url":"https://github.com/dutu/bisq-api-node","last_synced_at":"2025-12-02T21:06:44.421Z","repository":{"id":173911827,"uuid":"651474363","full_name":"dutu/bisq-api-node","owner":"dutu","description":"Node.js wrapper for local and remote Bisq API endpoints","archived":false,"fork":false,"pushed_at":"2024-02-15T09:42:36.000Z","size":25282,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-16T12:00:10.682Z","etag":null,"topics":["api","bisq","bisq-api","bisq-network","bitcoin","bsq","btc","daemon","exchange","grpc","grpc-client"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/bisq-api-node","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/dutu.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":"2023-06-09T10:09:40.000Z","updated_at":"2023-06-09T10:24:37.000Z","dependencies_parsed_at":null,"dependency_job_id":"d0c3d78a-4086-4815-a266-2c8d23f48943","html_url":"https://github.com/dutu/bisq-api-node","commit_stats":null,"previous_names":["dutu/bisq-api-node"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dutu%2Fbisq-api-node","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dutu%2Fbisq-api-node/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dutu%2Fbisq-api-node/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dutu%2Fbisq-api-node/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dutu","download_url":"https://codeload.github.com/dutu/bisq-api-node/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242135162,"owners_count":20077403,"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","bisq","bisq-api","bisq-network","bitcoin","bsq","btc","daemon","exchange","grpc","grpc-client"],"created_at":"2025-01-16T11:53:36.449Z","updated_at":"2025-12-02T21:06:39.375Z","avatar_url":"https://github.com/dutu.png","language":"JavaScript","readme":"bisq-api-node\n=============\n\n**bisq-api-node** is a Node.js wrapper that simplifies the process of interacting with both local and remote Bisq API endpoints.\n\nThe Bisq API is built on the gRPC framework.\u003cbr\u003e \n**bisq-api-node** abstracts away the complexities of gRPC communication. Developers can interact with the Bisq API in a simplified and intuitive manner, without the need to directly handle the intricacies of the underlying gRPC implementation.\n\nThe functionality of **bisq-api-node** is organized in a single class, making it straightforward to use.\n\n\n### Contents\n* [Install](#install)\n* [Usage](#usage)\n    * [Constructor](#constructor)\n    * [Methods](#methods)\n    * [Requirements for target Bisq API Daemon ](#requirements-for-target-bisq-api-daemon )\n\n\n# Install\n\n```shell\nnpm install --save bisq-api-node\n```\nor\n```shell\nyarn add bisq-api-node\n```\n\n# Usage\n\n## Constructor\n\n* `new Bisq({ ipAddress, password })`\n\nYou must supply the IP address of your Bisq daemon and the API password.\n\nExample:\n\n```js\nconst bisq = new Bisq({ ipAddress: '192.168.1.230:9998', password: 'myapiPassword' })\n```\n\n\n## Methods\n\nAvailable RPC Methods are described in the official [Bisq gRPC API reference documentation](https://bisq-network.github.io/slate/#introduction).\n\nA method can be simply accessed using the format `.serviceName.methodName`.\n\nFor example, you would call gRPC method `GetMarketPrice` of service `Price` like this:  `bisq.price.getMarketPrice({ currency_code: 'usd' })`.\n\u003e Note that both the service name and method name are starting with a small letter.\n\nAll methods accept one object parameter, which is used to pass all gRPC request parameters for the API call.\n\nAll methods return a promise.\n\nExample:\n```js\nresult  = await bisq.offers.getOffers({ direction: 'BUY', currency_code: 'xmr'})\nconsole.log(result)\n```\n\n\n## Requirements for target Bisq API Daemon \n\n* Java JDK 11 or 15\n\n* Bisq API Daemon installed and running \n\n\u003e Never Run API Daemon and Bisq GUI On Same Host At Same Time.\n\u003e \n\u003e The API daemon and the GUI share the same default wallet and connection ports. Beyond inevitable failures due to fighting over the wallet and ports, doing so will probably corrupt your wallet. Before starting the API daemon, make sure your GUI is shut down, and vice-versa. Please back up your mainnet wallet early and often with the GUI.\n\n\n### Running Bisq API daemon\n\nStart Bisq API Daemon:\n```shell\n# Shutdown Bisq GUI\nkill -15 $(pgrep Bisq)\n\n# Start Bisq API daemon\njava -jar daemon.jar --apiPort=9998 --apiPassword=becareful\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdutu%2Fbisq-api-node","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdutu%2Fbisq-api-node","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdutu%2Fbisq-api-node/lists"}