BitShares - a Collection of APIs Methods Names and more...

in #bitshares7 years ago (edited)

Learn from BitShares Documentation website - How it works.

bts-collection3.png



I created a simply listed BitShares APIs Method Names. There are many Method names. You might find some useful method names you are looking for. I added the links to the information pages. Please go and read the details. Also, I added BitSharea API related information that would be helpful to understand how it works.



BitShares - APIs

API Guide

APIs categories

  • Blockchain API -- It is used to query blockchain data (account, assets, trading history, etc.) Besides data stores in the blockchain itself (blocks, transactions, etc. ..), higher level objects (such as accounts, balances, etc. …) can be retrieved through the full node’s database.
  • Wallet API -- It has your private keys loaded and is required when interacting with the blockchain with new transactions.

API Calls

  • All API calls are formatted in JSON and return JSON only.
  • The set of available calls depends on whether you connected to a full node (witness_node) or the wallet (CLI-wallet). Both support RPC-JSON.
  • The full node also supports the websocket (statefull) protocol with notifications.
  • The full node offers a set of API(s), of which only the database calls are available via RPC. Calls that are restricted by default (i.e. network_node_api) or have been restricted by configuration are not accessible via RPC because a statefull protocol (websocket) is required for login.
  • The CLI- wallet can open a RPC port so that you can interface your application with it. You have the choices of
    • websocket RPC via the -rparameter, and
    • HTTP RPC via the -H parameter.

Call methods

  • Remote Procedure Calls -- In Graphene, RPC calls are state-less and accessible via regular JSON formated RPC-HTTP-calls.
  • Websocket Calls -- In Graphene, Websocket calls are stateful and accessible via regular JSON formated websocket connection.

API Access Restrictions

Access to some APIs may be restricted and requires login with username and passphrase. More details...

Network and Wallet Configuration - Network Setups




Blockchain APIs

Blockchain-APIs-Names1_Page_1.png

Blockchain-APIs-Names1_Page_2.png

Blockchain-APIs-Names2.png



Wallet API Calls

In order to interact the wallet, you need to run the CLI Wallet. The CLI Wallet has the private keys and signing capabilities. It requires a running full node (witness node) (not necessarily locally) and connects to it.

WalletCalls-APIs-Names_Page_1.png

WalletCalls-APIs-Names_Page_2.png


Blockchain Objects and their Identifiers

In the protocol space, there are raw objects such as, accounts, assets, committee members as well as orders, proposals and balances. The implementation space is used to gain access to higher abstraction layers for instance content of the current database state (these include, current global blockchain properties, dynamic asset data, transaction histories as well as account statistics and budget records).

Objects and IDs



Hope you could find some useful information for your BitShares project!

(do no vote. if you like it, please just share.) Thank you.

Sort:  

Would be cool if you explore the REST API with Insomnia or Postman and create a writeup. Nice writeup btw.

I made a BTS REST API recently: https://github.com/BTS-CM/Bitshares-HUG-REST-API

This made me realize that I am a noob and that I didn't know that JSON RPC and REST are different lol. I just learned something. Thanks for the link.

Very nice!!

Congratulations @tsugimoto! You have received a personal award!

2 Years on Steemit
Click on the badge to view your own Board of Honor on SteemitBoard.

Upvote this notificationto to help all Steemit users. Learn why here!