create account

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

View this thread on: hive.blogpeakd.comecency.com
· @tsugimoto · (edited)
$30.46
BitShares - a Collection of APIs Methods Names and more...
## Learn from BitShares Documentation website - How it works.


![bts-collection3.png](https://steemitimages.com/DQmP8SvBn4WiV6wH3MgxBkrPFLk9crQbCeadnPh4PYQs1y1/bts-collection3.png)

---

<br/>

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.


-----

<br/>


# BitShares -  APIs

## [API Guide](http://docs.bitshares.eu/api/index.html)


### 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](http://docs.bitshares.eu/integration/apps/cliwallet.html) can open a RPC port so that you can interface your application with it. You have the choices of 
     - websocket RPC via the `-r `parameter, and 
     - HTTP RPC via the `-H` parameter.

### Call methods
* [Remote Procedure Calls](http://docs.bitshares.eu/api/rpc.html) -- In Graphene, RPC calls are **state-less** and accessible via regular JSON formated RPC-HTTP-calls.
* [Websocket Calls](http://docs.bitshares.eu/api/websocket.html) -- 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...](http://docs.bitshares.eu/api/access.html)

### Network and Wallet Configuration  - [Network Setups](http://docs.bitshares.eu/integration/network-setup.html)
* [General Network and Wallet Configuration](http://docs.bitshares.eu/integration/tutorials/general-network-setup.html)
* [Secure Network and Wallet Configuration](http://docs.bitshares.eu/integration/tutorials/secure-network-setup.html)


-----

----

<br /> 

## [Blockchain APIs](http://docs.bitshares.eu/api/blockchain-api.html)

* [Database API](http://docs.bitshares.eu/api/database.html)
* [Account History API](http://docs.bitshares.eu/api/history.html)
* [Crypto API](http://docs.bitshares.eu/api/crypto.html)
* [Network Broadcast API](http://docs.bitshares.eu/api/network_broadcast.html)
* [Network Nodes API](http://docs.bitshares.eu/api/network_node.html)




![Blockchain-APIs-Names1_Page_1.png](https://steemitimages.com/DQmPRK7XmJm6tRmY6MbnuGXUaeayuqdfQEtjJgCPKnmFnoR/Blockchain-APIs-Names1_Page_1.png)

![Blockchain-APIs-Names1_Page_2.png](https://steemitimages.com/DQmRn1DcCNnLfS4vohxRDBiVScVXEr4o76AigZ3Ly7dAnef/Blockchain-APIs-Names1_Page_2.png)


![Blockchain-APIs-Names2.png](https://steemitimages.com/DQmPp1TSSNH6hyr3YPTZMs7ZQ67jGyzYZWpYEsL1yL2m36w/Blockchain-APIs-Names2.png)

-----

<br />

## [Wallet API Calls](http://docs.bitshares.eu/api/wallet-api.html)

In order to interact the wallet, you need to run the [CLI Wallet](http://docs.bitshares.eu/integration/apps/cliwallet.html). 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](https://steemitimages.com/DQmdC9hZMWDnLTPzHtm9SY697zie3qZg9XnNBFPVgcZMRYP/WalletCalls-APIs-Names_Page_1.png)


![WalletCalls-APIs-Names_Page_2.png](https://steemitimages.com/DQmcprHKQSdtxDseGpkWEoEhreHggyKUH6Wex7GT9qwBh2p/WalletCalls-APIs-Names_Page_2.png)


<br />

## 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](http://docs.bitshares.eu/development/blockchain/objects.html)


<br />

----

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

(do no vote. if you like it, please just share.)    Thank you.
πŸ‘  , , , , , , , , , , , , , , , , , , , ,
πŸ‘Ž  
properties (23)
authortsugimoto
permlinkbitshares-a-collection-of-apis-methods-names
categorybitshares
json_metadata{"tags":["bitshares","tutorial","blockchain","crypto","steemit"],"image":["https://steemitimages.com/DQmP8SvBn4WiV6wH3MgxBkrPFLk9crQbCeadnPh4PYQs1y1/bts-collection3.png","https://steemitimages.com/DQmPRK7XmJm6tRmY6MbnuGXUaeayuqdfQEtjJgCPKnmFnoR/Blockchain-APIs-Names1_Page_1.png","https://steemitimages.com/DQmRn1DcCNnLfS4vohxRDBiVScVXEr4o76AigZ3Ly7dAnef/Blockchain-APIs-Names1_Page_2.png","https://steemitimages.com/DQmPp1TSSNH6hyr3YPTZMs7ZQ67jGyzYZWpYEsL1yL2m36w/Blockchain-APIs-Names2.png","https://steemitimages.com/DQmdC9hZMWDnLTPzHtm9SY697zie3qZg9XnNBFPVgcZMRYP/WalletCalls-APIs-Names_Page_1.png","https://steemitimages.com/DQmcprHKQSdtxDseGpkWEoEhreHggyKUH6Wex7GT9qwBh2p/WalletCalls-APIs-Names_Page_2.png"],"links":["http://docs.bitshares.eu/api/index.html","http://docs.bitshares.eu/integration/apps/cliwallet.html","http://docs.bitshares.eu/api/rpc.html","http://docs.bitshares.eu/api/websocket.html","http://docs.bitshares.eu/api/access.html","http://docs.bitshares.eu/integration/network-setup.html","http://docs.bitshares.eu/integration/tutorials/general-network-setup.html","http://docs.bitshares.eu/integration/tutorials/secure-network-setup.html","http://docs.bitshares.eu/api/blockchain-api.html","http://docs.bitshares.eu/api/database.html","http://docs.bitshares.eu/api/history.html","http://docs.bitshares.eu/api/crypto.html","http://docs.bitshares.eu/api/network_broadcast.html","http://docs.bitshares.eu/api/network_node.html","http://docs.bitshares.eu/api/wallet-api.html","http://docs.bitshares.eu/development/blockchain/objects.html"],"app":"steemit/0.1","format":"markdown"}
created2018-04-02 04:20:24
last_update2018-04-03 18:42:57
depth0
children5
last_payout2018-04-09 04:20:24
cashout_time1969-12-31 23:59:59
total_payout_value23.906 HBD
curator_payout_value6.555 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length5,043
author_reputation11,510,069,173,867
root_title"BitShares - a Collection of APIs Methods Names and more..."
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id47,866,416
net_rshares10,211,095,923,594
author_curate_reward""
vote details (22)
@netscape101 ·
Would be cool if you explore the REST API with Insomnia or Postman and create a writeup. Nice writeup btw.
properties (22)
authornetscape101
permlinkre-tsugimoto-bitshares-a-collection-of-apis-methods-names-20180402t123636953z
categorybitshares
json_metadata{"tags":["bitshares"],"app":"steemit/0.1"}
created2018-04-02 12:36:39
last_update2018-04-02 12:36:39
depth1
children3
last_payout2018-04-09 12:36:39
cashout_time1969-12-31 23:59:59
total_payout_value0.000 HBD
curator_payout_value0.000 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length106
author_reputation45,783,947,118
root_title"BitShares - a Collection of APIs Methods Names and more..."
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id47,926,246
net_rshares0
@cm-steem · (edited)
I made a BTS REST API recently: https://github.com/BTS-CM/Bitshares-HUG-REST-API
πŸ‘  ,
properties (23)
authorcm-steem
permlinkre-netscape101-re-tsugimoto-bitshares-a-collection-of-apis-methods-names-20180402t141302044z
categorybitshares
json_metadata{"tags":["bitshares"],"links":["https://github.com/BTS-CM/Bitshares-HUG-REST-API"],"app":"steemit/0.1"}
created2018-04-02 13:13:00
last_update2018-04-02 13:13:30
depth2
children2
last_payout2018-04-09 13:13:00
cashout_time1969-12-31 23:59:59
total_payout_value0.000 HBD
curator_payout_value0.000 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length80
author_reputation58,522,774,254,119
root_title"BitShares - a Collection of APIs Methods Names and more..."
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id47,931,577
net_rshares1,093,165,443
author_curate_reward""
vote details (2)
@netscape101 ·
$0.18
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.
πŸ‘  
properties (23)
authornetscape101
permlinkre-cm-steem-re-netscape101-re-tsugimoto-bitshares-a-collection-of-apis-methods-names-20180404t094824392z
categorybitshares
json_metadata{"tags":["bitshares"],"app":"steemit/0.1"}
created2018-04-04 09:48:24
last_update2018-04-04 09:48:24
depth3
children0
last_payout2018-04-11 09:48:24
cashout_time1969-12-31 23:59:59
total_payout_value0.132 HBD
curator_payout_value0.043 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length149
author_reputation45,783,947,118
root_title"BitShares - a Collection of APIs Methods Names and more..."
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id48,269,993
net_rshares58,238,385,439
author_curate_reward""
vote details (1)
@tsugimoto ·
Very nice!!
properties (22)
authortsugimoto
permlinkre-cm-steem-re-netscape101-re-tsugimoto-bitshares-a-collection-of-apis-methods-names-20180403t184052302z
categorybitshares
json_metadata{"tags":["bitshares"],"app":"steemit/0.1"}
created2018-04-03 18:40:51
last_update2018-04-03 18:40:51
depth3
children0
last_payout2018-04-10 18:40:51
cashout_time1969-12-31 23:59:59
total_payout_value0.000 HBD
curator_payout_value0.000 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length11
author_reputation11,510,069,173,867
root_title"BitShares - a Collection of APIs Methods Names and more..."
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id48,164,704
net_rshares0
@steemitboard ·
Congratulations @tsugimoto! You have received a personal award!

[![](https://steemitimages.com/70x70/http://steemitboard.com/@tsugimoto/birthday2.png)](http://steemitboard.com/@tsugimoto)  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](https://steemit.com/steemitboard/@steemitboard/http-i-cubeupload-com-7ciqeo-png)!
properties (22)
authorsteemitboard
permlinksteemitboard-notify-tsugimoto-20180520t054032000z
categorybitshares
json_metadata{"image":["https://steemitboard.com/img/notifications.png"]}
created2018-05-20 05:40:33
last_update2018-05-20 05:40:33
depth1
children0
last_payout2018-05-27 05:40:33
cashout_time1969-12-31 23:59:59
total_payout_value0.000 HBD
curator_payout_value0.000 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length432
author_reputation38,975,615,169,260
root_title"BitShares - a Collection of APIs Methods Names and more..."
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id56,655,525
net_rshares0