PHPackages                             dan-da/bisq-api - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. dan-da/bisq-api

ActiveLibrary[API Development](/categories/api)

dan-da/bisq-api
===============

06PHP

Since Apr 8Pushed 9y ago1 watchersCompare

[ Source](https://github.com/dan-da/bisq-api)[ Packagist](https://packagist.org/packages/dan-da/bisq-api)[ RSS](/packages/dan-da-bisq-api/feed)WikiDiscussions master Synced 2mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

bisq-api
========

[](#bisq-api)

This repository contains files pertaining to bisq APIs.

In particular the areas of:

- specification
- documentation
- schema validation
- unit testing

Installation
------------

[](#installation)

### composer is required.

[](#composer-is-required)

On Ubuntu 16.04:

```
sudo apt install composer

```

On Ubuntu 14.04

```
curl -sS https://getcomposer.org/installer | sudo php -- --install-dir=/usr/local/bin --filename=composer

```

Anything else, visit .

### now let's get to it!

[](#now-lets-get-to-it)

```
$ git clone https://github.com/dan-da/bisq-api.git
$ cd bisq-api
$ composer install

```

Building Docs
-------------

[](#building-docs)

```
$ ./build-api-docs.sh
API Docs are in apis/index.html and apis/README.md

```

Also, docs are viewable online at:

Running unit tests
------------------

[](#running-unit-tests)

The tests run against a running bisq (bitsquare) instance.

At the time of this writing, API support is only available in bisq on development branch issue544-api. So it is necessary to checkout and build that branch first. When you have done this, then you need to start bitsquare and ensure that it is listening on port 8080.

You can verify that bitsquare API support is working by loading this url in a browser: [http://localhost:8080/apis/currency\_list](http://localhost:8080/apis/currency_list)

Once that is working, proceed to run unit tests as follows:

```
$ ./run-api-tests.sh
 _____ ___  ___ _____ ___  ___
|_   _/ __)( __/_   _/ __)| _ )
  |_| \___ /___) |_| \___ |_|_\  v1.7.1

PHP 7.0.15-0ubuntu0.16.04.4 | '/usr/bin/php' -c '/tmp/.php.ini' | 8 threads

...

OK (3 tests, 0.1 seconds)

```

Directory layout
----------------

[](#directory-layout)

/ project root. contains shell scripts to perform actions. apis/ api root lib/ some common files each api has its own directory with apidoc, schema, and unit test files. vendor/ built automatically by composer.

Docs build system
-----------------

[](#docs-build-system)

Documentation for each api is contained in /apis/<api>/apidoc.php in a structured data format without any display markup.

The build-api-docs.sh script processes each API directory and generates documentation in both HTML and markdown formats. In the future it could be extended to generated PDF or anything else.

JSON Schema for API responses
-----------------------------

[](#json-schema-for-api-responses)

API responses contain complex structured data that is difficult to validate manually.

As such, a json schema is created for each API response, located in /apis/<api>/schema.json.

Initially, these schemas are created automagically by providing a sample JSON response to this tool:

Further manual editing of the schemas may be desirable as we go forward.

The unit tests for each API perform an API call and then validate the response against the schema. Any validation error will cause the test to fail and the errors are reported.

API Versioning.
---------------

[](#api-versioning)

The API will be versioned according to the bitsquare release version.

There is no separate versioning.

###  Health Score

20

—

LowBetter than 14% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity4

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity41

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/e87d6b2a83a8e59034011ac8752ebe495e09793f4baa9ace68a1329a459c3aae?d=identicon)[danda](/maintainers/danda)

---

Top Contributors

[![dan-da](https://avatars.githubusercontent.com/u/5110592?v=4)](https://github.com/dan-da "dan-da (4 commits)")

### Embed Badge

![Health badge](/badges/dan-da-bisq-api/health.svg)

```
[![Health](https://phpackages.com/badges/dan-da-bisq-api/health.svg)](https://phpackages.com/packages/dan-da-bisq-api)
```

###  Alternatives

[stripe/stripe-php

Stripe PHP Library

4.0k143.3M480](/packages/stripe-stripe-php)[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M272](/packages/twilio-sdk)[knplabs/github-api

GitHub API v3 client

2.2k15.8M187](/packages/knplabs-github-api)[facebook/php-business-sdk

PHP SDK for Facebook Business

90121.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php

PHP wrapper for the Meilisearch API

73813.7M114](/packages/meilisearch-meilisearch-php)[google/gax

Google API Core for PHP

263103.1M454](/packages/google-gax)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)