Vertex Protocol Python SDK

This is the Python SDK for the Vertex Protocol API.

The latest version of the SDK can be found on PyPI, and the source code is on GitHub.

Note

👋 Brand new to Vertex?

0. Join the Vertex community via Discord, Twitter.

1. Read our docs to learn the basic concepts.

2. Visit us at Vertex Protocol.

3. The Getting started section will give you a quick idea of the core things you can do via the SDK!

Requirements

• Python 3.9 or above

Installation

You can install the SDK via pip:

pip install vertex-protocol

You might want to use a virtual environment to isolate your packages.

Contents:

• Getting started
  • Introduction
  • Basic usage
  • Making a deposit
  • Placing an order
  • Viewing open orders
  • Retrieving an order digest
  • Cancelling an order
  • Withdrawing collateral
• User reference
  • Core client
  • Market API
  • Spot API
  • Perp API
  • Subaccount API
  • Engine Client
  • Indexer Client
  • Vertex Contracts
  • Vertex utils
• User guides
  • Signing
• API Reference
  • vertex_protocol.client
  • vertex_protocol.client.apis
  • vertex-protocol.engine_client
  • vertex-protocol.engine_client.types
  • vertex-protocol.indexer_client
  • vertex-protocol.indexer_client.types
  • vertex-protocol.contracts
  • vertex-protocol.contracts.eip712
  • vertex-protocol.utils