Skip to content

Latest commit

 

History

History

rest

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 
date-range.py
date-range.py
 
 
estimate-fees-and-margin.py
estimate-fees-and-margin.py
 
 
get-accounts.py
get-accounts.py
 
 
get-assets.py
get-assets.py
 
 
get-balances.py
get-balances.py
 
 
get-candles.py
get-candles.py
 
 
get-checkpoints.py
get-checkpoints.py
 
 
get-delegations.py
get-delegations.py
 
 
get-deposits.py
get-deposits.py
 
 
get-epochs.py
get-epochs.py
 
 
get-governance-proposals.py
get-governance-proposals.py
 
 
get-governance-votes.py
get-governance-votes.py
 
 
get-key-rotations.py
get-key-rotations.py
 
 
get-ledger-entries.py
get-ledger-entries.py
 
 
get-liquidity-provisions.py
get-liquidity-provisions.py
 
 
get-margin-levels.py
get-margin-levels.py
 
 
get-market-data.py
get-market-data.py
 
 
get-market-depth.py
get-market-depth.py
 
 
get-markets.py
get-markets.py
 
 
get-network-data-and-limits.py
get-network-data-and-limits.py
 
 
get-network-parameters.py
get-network-parameters.py
 
 
get-node-data.py
get-node-data.py
 
 
get-orders.py
get-orders.py
 
 
get-parties.py
get-parties.py
 
 
get-positions.py
get-positions.py
 
 
get-rewards.py
get-rewards.py
 
 
get-staking-data.py
get-staking-data.py
 
 
get-statistics.py
get-statistics.py
 
 
get-trades.py
get-trades.py
 
 
get-transfers.py
get-transfers.py
 
 
get-vega-time.py
get-vega-time.py
 
 
get-withdrawals.py
get-withdrawals.py
 
 
helpers.py
helpers.py
 
 
liquidity-commitment-amend.py
liquidity-commitment-amend.py
 
 
liquidity-commitment-cancel.py
liquidity-commitment-cancel.py
 
 
liquidity-commitment-submit.py
liquidity-commitment-submit.py
 
 
liquidity-commitments-list.py
liquidity-commitments-list.py
 
 
login.py
login.py
 
 
logout.py
logout.py
 
 
order-amend.py
order-amend.py
 
 
order-cancel.py
order-cancel.py
 
 
order-submit.py
order-submit.py
 
 
pagination.py
pagination.py
 
 
pegged-order-amend.py
pegged-order-amend.py
 
 
pegged-order-cancel.py
pegged-order-cancel.py
 
 
pegged-order-submit.py
pegged-order-submit.py
 
 
propose-vote-enact-freeform.py
propose-vote-enact-freeform.py
 
 
propose-vote-enact-network-params.py
propose-vote-enact-network-params.py
 
 
propose-vote-enact-new-market.py
propose-vote-enact-new-market.py
 
 
requirements.txt
requirements.txt
 
 
stream-accounts.py
stream-accounts.py
 
 
stream-candles.py
stream-candles.py
 
 
stream-delegations.py
stream-delegations.py
 
 
stream-governance.py
stream-governance.py
 
 
stream-margin-levels.py
stream-margin-levels.py
 
 
stream-market-data.py
stream-market-data.py
 
 
stream-market-depth-updates.py
stream-market-depth-updates.py
 
 
stream-market-depth.py
stream-market-depth.py
 
 
stream-orders.py
stream-orders.py
 
 
stream-positions.py
stream-positions.py
 
 
stream-rewards.py
stream-rewards.py
 
 
stream-trades.py
stream-trades.py
 
 
stream-votes.py
stream-votes.py
 
 
submit-amend-cancel-liquidity-commitment.py
submit-amend-cancel-liquidity-commitment.py
 
 
submit-amend-cancel-order.py
submit-amend-cancel-order.py
 
 
submit-amend-cancel-pegged-order.py
submit-amend-cancel-pegged-order.py
 
 

README.md

REST API samples in Python

The files here represent how to call various aspects of the Vega data-node REST APIs and Wallet APIs programmatically using Python.

REFERENCE APIs: Reference API documentation for the REST APIs can be found at: https://docs.vega.xyz/

Prerequisites

Ensure you have set up vega-config on your environment as explained in the main Getting Started guides.

The following tools or applications are required for these scripts to work. Here are the commands to check they are installed on your system:

  1. python3

    python3 --version

  2. pip3

    pip3 --version

    To make sure we have all the correct libraries you can use pip with the requirements.txt to install them all

    pip3 install -r requirements.txt

    To make sure you have all the tools required and have setup your environment correctly, it is best to try out the most basic vega-time script.

    python3 get-vega-time.py

  3. Import the appropriate vega-config into your local environment for the network you want to test against (default vega-config is Fairground testnet).

    source vega-config

  4. wallet

    If this correctly gets the Vega blockchain time then next we need to authenticate with the Vega wallet API so that the scripts can sign transactions.

    python3 login.py

    Run the login script, enter your wallet username and passphrase to authenticate and store a token for use in scripts such as submit-amend-cancel-order.py

    To logout or remove the token, simply run the logout script or delete token.temp

    python3 logout.py

How to run a script

All the source files are named logically so that the caller can read the file tree and understand the actions performed within. Hint: If you do not require all of the actions within a script, simply comment them out.

If the prerequisites are installed and set up correctly you can run a simple query or 'read' action script as follows:

python3 get-statistics.py

To run a 'write' action, sending a command into Vega, make sure you are authenticated first and have edited the file to your requirements:

python3 submit-amend-cancel-order.py

Finally to run a streaming action (the code is set to exit after 30 seconds):

python3 stream-market-data.py