Skip to content

Commit

Permalink
Adding v4-client-py-v2
Browse files Browse the repository at this point in the history
  • Loading branch information
samtin0x committed Jun 13, 2024
2 parents a176b9f + ceabea0 commit b561c45
Show file tree
Hide file tree
Showing 65 changed files with 5,990 additions and 0 deletions.
171 changes: 171 additions & 0 deletions v4-client-py-v2/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,171 @@
### Python ###
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
.pybuilder/
target/

# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version

# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock

# poetry
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
#poetry.lock

# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
#pdm.lock
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
# in version control.
# https://pdm.fming.dev/#use-with-ide
.pdm.toml

# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__pypackages__/

# Celery stuff
celerybeat-schedule
celerybeat.pid

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/

# pytype static type analyzer
.pytype/

# Cython debug symbols
cython_debug/

# PyCharm
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/

### Python Patch ###
# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
poetry.toml

# ruff
.ruff_cache/

# LSP config files
pyrightconfig.json
11 changes: 11 additions & 0 deletions v4-client-py-v2/.pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
repos:
- repo: https://github.com/psf/black
rev: 24.4.0
hooks:
- id: black
language_version: python3.12
- repo: https://github.com/pycqa/isort
rev: 5.13.2
hooks:
- id: isort
name: isort (python)
85 changes: 85 additions & 0 deletions v4-client-py-v2/DIFF.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
## Comparison of Differences

### `Indexer` Coverage Analysis

This table compares the method names in the Python client with those found in the API documentation.

Symbols:
`=` - The method names are the same in both the client and API
`-` - The method is missing from the client library

| Method Name (sync client) | API Method (docs) | Method | Path |
| ---------------------------------- | -------------------- | ------ | ------------------------------------ |
| get_subaccounts | GetAddress | GET | /addresses |
| get_subaccount = | GetSubaccount | GET | /addresses/{}/subaccountNumber/{} |
| get_subaccount_asset_positions | GetAssetPositions | GET | /assetPositions |
| get_perpetual_market_candles | GetCandles | GET | /candles/perpetualMarkets |
| get_screen | Screen | GET | /screen |
| get_subaccount_fills | GetFills | GET | /fills |
| get_height = | GetHeight | GET | /height |
| get_perpetual_market_funding | GetHistoricalFunding | GET | /historicalFunding |
| get_subaccount_historical_pnls | GetHistoricalPnl | GET | /historical-pnl |
| get_perpetual_market_orderbook | GetPerpetualMarket | GET | /orderbooks/perpetualMarket |
| get_subaccount_orders | ListOrders | GET | /orders |
| get_order = | GetOrder | GET | /orders/{} |
| get_perpetual_markets | ListPerpetualMarkets | GET | /perpetualMarkets |
| get_subaccount_perpetual_positions | ListPositions | GET | /perpetualPositions |
| get_perpetual_markets_sparklines | Get | GET | /sparklines |
| get_time = | GetTime | GET | /time |
| get_perpetual_market_trades | GetTrades | GET | /trades/perpetualMarket |
| get_subaccount_transfers | GetTransfers | GET | /transfers |
| - (no Py, no TS) | GetTradingRewards | GET | /historicalBlockTradingRewards |
| - (no Py, no TS) | GetAggregations | GET | /historicalTradingRewardAggregations |

#### Categorization:

Should the methods be grouped into `Account`, `Market`, and `Utility` sections?

### Data Types Analysis

#### `MarketType`

- The `CROSS` enumeration option is not documented.

#### `PerpetualMarketResponse`

- The `openInterestLowerCap` and `openInterestUpperCap` fields are always empty and not documented. Are they new, optional, or obsolete?

#### `PerpetualPositionResponseObject`

- `subaccount_number` is present but undocumented.

#### `FillResponseObject`

- Contains `subaccountNumber`, but it is not documented.

### Method-Specific Observations

#### `ListPerpetualMarkets`

- The `limit` parameter is optional.

#### `GetTrades`

- The `limit` parameter is optional.

#### `GetCandles`

- The `limit` parameter is optional.

#### `GetAddress`

- Although the implementation includes a `limit` parameter, it is undocumented.

#### `GetSubaccount`

- Returns `SubaccountResponse`, not `SubaccountResponseObject`. The former is a map with a single `subaccount` field.
- The `limit` and `status` parameters are optional.

#### `GetAssetPositions`

- Additional parameters similar to `ListPositions` exist but are undocumented.

#### `ListOrders`

- The `OrderResponseObject` includes an optional `goodTilBlock` field that is not present in responses.
Loading

0 comments on commit b561c45

Please sign in to comment.