teambtcmap/btcmap-general
8
0
Fork 0
Code Issues 9 Pull Requests Actions Packages Projects Releases Wiki Activity

Updated API Overview (markdown)

Nathan Day 2025-03-03 14:28:47 +00:00
parent 67fef8392c
commit 7501b69297
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
API-Overview.md

@ -1,6 +1,8 @@
Here is our [API Documentation](https://github.com/teambtcmap/btcmap-api/blob/master/docs/README.md)
We have two APIs: We have two APIs:
* [REST API](rest-api.md) - a read-only restful API that returns data on a variety of primitives, including elements (merchants), areas (countries and communities), reports and users. * [REST API](https://github.com/teambtcmap/btcmap-api/blob/master/docs/rest-api/README.md) - a read-only restful API that returns data on a variety of primitives, including elements (merchants), areas (countries and communities), reports and users.
* [RPC API](rpc-api.md) - a combination of read and write RPCs that enables clients to request data AND write data to the BTC Map API. * [RPC API](https://github.com/teambtcmap/btcmap-api/blob/master/docs/rpc-api/README.md) - a combination of read and write RPCs that enables clients to request data AND write data to the BTC Map API.