Skip to content

Commit

Permalink
update api parameters description
Browse files Browse the repository at this point in the history
  • Loading branch information
zhumingu committed Aug 8, 2016
1 parent 1235dbe commit 3348dd8
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 2 deletions.
4 changes: 2 additions & 2 deletions source/api/basic-api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -114,8 +114,8 @@ Address History
* ``since_address`` *(optional)* *(string)* - from which address to list.

.. note::
``path`` 0 means receiving addresses, and path 1 means change addresses.
``since_address`` null represents that start from the beginning.
* ``path`` 0 means receiving addresses, and path 1 means change addresses.
* ``since_address`` null represents that start from the beginning.

Address Next
------------
Expand Down
15 changes: 15 additions & 0 deletions source/api/hot-sending-api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,21 @@ Hot Sending Tx Request
"result": true
}

**Parameters**:
* ``coin_code`` *(optional)* *(string)* - coin type, for example *(BTC)*.
* ``user_tx_no`` *(required)* *(string)* - tx id in vweb.
* ``address`` *(required)* *(string)* - transfer to address.
* ``value`` *(required)* *(long)* - amount of satoshi.
* ``vc_code`` *(required)* *(string)* - the sign of unsigntx.
* ``is_dynamic_fee`` *(optional)* *(int)* - whether to charge the dynamic fee.
* ``c_id`` *(required)* *(int)* - the channel id of sms to sign.

.. note::
* ``coin_code`` default *(BTC)*.
* ``user_tx_no`` unique in vweb.
* ``is_dynamic_fee`` 0 no 1 yes default 1.
* ``vc_code`` and ``c_id`` is use to ensure security .

Hot Sending Tx Detail
---------------------

Expand Down

0 comments on commit 3348dd8

Please sign in to comment.