jupiter-python-sdk-public


Namejupiter-python-sdk-public JSON
Version 0.0.2.2 PyPI version JSON
download
home_pageNone
SummaryJupiter Python SDK
upload_time2025-01-09 08:59:54
maintainerNone
docs_urlNone
authorSamuel Sallee
requires_pythonNone
licenseLICENSE.txt
keywords python solana jupiter dex trading sdk
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            
<div align="center">
    <h1>🐍 JUPITER PYTHON SDK 🪐</h1>
    <img src="https://github.com/0xTaoDev/jupiter-python-sdk/blob/main/images/jupiter-python-sdk-banner.png?raw=true" width="75%" height="75%">
</div>

---

<p align="center">
    <img src="https://img.shields.io/github/stars/0xtaodev/jupiter-python-sdk">
    <img src="https://img.shields.io/github/forks/0xtaodev/jupiter-python-sdk">
    <br>
    <img src="https://img.shields.io/github/issues/0xtaodev/jupiter-python-sdk">
    <img src="https://img.shields.io/github/issues-closed/0xtaodev/jupiter-python-sdk">
    <br>
    <img src="https://img.shields.io/github/languages/top/0xtaodev/jupiter-python-sdk">
    <img src="https://img.shields.io/github/last-commit/0xtaodev/jupiter-python-sdk">
    <br>
</p>

# 📖 Introduction
**Jupiter Python SDK** is a Python library that allows you to use most of **[Jupiter](https://jup.ag/) features**.<br>
It enables executing swaps, limit orders, DCA, swap pairs, tokens prices, fetching wallet infos, stats, data and more!<br>
This library is using packages like: [solana-py](https://github.com/michaelhly/solana-py), [solders](https://github.com/kevinheavey/solders), [anchorpy](https://github.com/kevinheavey/anchorpy).<br>
There is documentation inside each function, however, you can access to the [official Jupiter API](https://docs.jup.ag/docs) for more information.

# ⚠️ Disclaimer
**Please note that I'm not responsible for any loss of funds, damages, or other libailities resulting from the use of this software or any associated services.<br>
This tool is provided for educational purposes only and should not be used as financial advice, it is still in expiremental phase so use it at your own risk.**

# ✨ Quickstart

### 🛠️ Installation

```sh
pip install jupiter-python-sdk
```

### 📃 General Usage
**Providing the private key and RPC client is not mandatory if you only intend to execute functions for retrieving data.<br>
Otherwise, this is required, for instance, to open a DCA account or to close one.**

**You can set custom URLs for any self-hosted Jupiter APIs. Like the [V6 Swap API](https://station.jup.ag/docs/apis/self-hosted) or [QuickNode's Metis API](https://marketplace.quicknode.com/add-on/metis-jupiter-v6-swap-api).**

If you encounter ```ImportError: cannot import name 'sync_native' from 'spl.token.instructions``` error when trying to import Jupiter, Jupiter_DCA from jupiter_python_sdk.jupiter, follow these steps:
1. Go to https://github.com/michaelhly/solana-py/tree/master/src/spl/token and download ```instructions.py```
2. In your packages folder, replace ```spl/token/instructions.py``` with the one you just downloaded.

### Here is a code snippet on how to use the SDK
```py
import base58
import base64
import json

from solders import message
from solders.pubkey import Pubkey
from solders.keypair import Keypair
from solders.transaction import VersionedTransaction

from solana.rpc.types import TxOpts
from solana.rpc.async_api import AsyncClient
from solana.rpc.commitment import Processed

from jupiter_python_sdk.jupiter import Jupiter, Jupiter_DCA


private_key = Keypair.from_bytes(base58.b58decode(os.getenv("PRIVATE-KEY"))) # Replace PRIVATE-KEY with your private key as string
async_client = AsyncClient("SOLANA-RPC-ENDPOINT-URL") # Replace SOLANA-RPC-ENDPOINT-URL with your Solana RPC Endpoint URL
jupiter = Jupiter(
    async_client=async_client,
    keypair=private_key,
    quote_api_url="https://quote-api.jup.ag/v6/quote?",
    swap_api_url="https://quote-api.jup.ag/v6/swap",
    open_order_api_url="https://jup.ag/api/limit/v1/createOrder",
    cancel_orders_api_url="https://jup.ag/api/limit/v1/cancelOrders",
    query_open_orders_api_url="https://jup.ag/api/limit/v1/openOrders?wallet=",
    query_order_history_api_url="https://jup.ag/api/limit/v1/orderHistory",
    query_trade_history_api_url="https://jup.ag/api/limit/v1/tradeHistory"
)


"""
EXECUTE A SWAP
"""
transaction_data = await jupiter.swap(
    input_mint="So11111111111111111111111111111111111111112",
    output_mint="EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
    amount=5_000_000,
    slippage_bps=1,
)
# Returns str: serialized transactions to execute the swap.

raw_transaction = VersionedTransaction.from_bytes(base64.b64decode(transaction_data))
signature = private_key.sign_message(message.to_bytes_versioned(raw_transaction.message))
signed_txn = VersionedTransaction.populate(raw_transaction.message, [signature])
opts = TxOpts(skip_preflight=False, preflight_commitment=Processed)
result = await async_client.send_raw_transaction(txn=bytes(signed_txn), opts=opts)
transaction_id = json.loads(result.to_json())['result']
print(f"Transaction sent: https://explorer.solana.com/tx/{transaction_id}")


"""
OPEN LIMIT ORDER
"""
transaction_data = await jupiter.open_order(
    input_mint=So11111111111111111111111111111111111111112",
    output_mint=EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
    in_amount=5_000_000,
    out_amount=100_000,
)
# Returns dict: {'transaction_data': serialized transactions to create the limit order, 'signature2': signature of the account that will be opened}

raw_transaction = VersionedTransaction.from_bytes(base64.b64decode(transaction_data['transaction_data']))
signature = private_key.sign_message(message.to_bytes_versioned(raw_transaction.message))
signed_txn = VersionedTransaction.populate(raw_transaction.message, [signature, transaction_data['signature2']])
opts = TxOpts(skip_preflight=False, preflight_commitment=Processed)
result = await async_client.send_raw_transaction(txn=bytes(signed_txn), opts=opts)
transaction_id = json.loads(result.to_json())['result']
print(f"Transaction sent: https://explorer.solana.com/tx/{transaction_id}")


"""
CREATE DCA ACCOUNT
"""
create_dca_account = await jupiter.dca.create_dca(
    input_mint=Pubkey.from_string("So11111111111111111111111111111111111111112"),
    output_mint=Pubkey.from_string("EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v"),
    total_in_amount=5_000_000,
    in_amount_per_cycle=100_000,
    cycle_frequency=60,
    min_out_amount_per_cycle=0,
    max_out_amount_per_cycle=0,
    start=0
)
# Returns DCA Account Pubkey and transaction hash.


"""
CLOSE DCA ACCOUNT
"""
close_dca_account = await jupiter.dca.close_dca(
    dca_pubkey=Pubkey.from_string("45iYdjmFUHSJCQHnNpWNFF9AjvzRcsQUP9FDBvJCiNS1")
)
# Returns transaction hash.
```

### 📜 All available features
```py
- quote
- swap
- open_order
- cancel_orders
- create_dca
- close_dca
- fetch_user_dca_accounts
- fetch_dca_account_fills_history
- get_available_dca_tokens
- fetch_dca_data
- query_open_orders
- query_orders_history
- query_trades_history
- get_jupiter_stats
- get_token_price
- get_indexed_route_map
- get_tokens_list
- get_all_tickers
- get_all_swap_pairs
- get_swap_pairs
- get_token_stats_by_date
- program_id_to_label
```

# 📝 TO-DO
- [ ] Bridge 🌉
- [ ] Perpetual 💸

# 🤝 Contributions
If you are interesting in contributing, fork the repository and submit a pull request in order to merge your improvements into the main repository.<br>
Contact me for any inquiry, I will reach you as soon as possible.<br>
[![Discord](https://img.shields.io/badge/Discord-%237289DA.svg?logo=discord&logoColor=white)](https://discord.gg/QxwPGcXDp7)
[![Twitter](https://img.shields.io/badge/Twitter-%231DA1F2.svg?logo=Twitter&logoColor=white)](https://twitter.com/_TaoDev_)

# 👑 Donations
This project doesn't include platform fees. If you find value in it and would like to support its development, your donations are greatly appreciated.<br>
**SOLANA ADDRESS**
```sh
AyWu89SjZBW1MzkxiREmgtyMKxSkS1zVy8Uo23RyLphX
```

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "jupiter-python-sdk-public",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "python, solana, jupiter, dex, trading, sdk",
    "author": "Samuel Sallee",
    "author_email": "sam@tenxor.sh",
    "download_url": "https://files.pythonhosted.org/packages/96/ce/b3317f4fe5b8393ed1501334609e93b97d21333e893fdcb48256c117c823/jupiter_python_sdk_public-0.0.2.2.tar.gz",
    "platform": null,
    "description": "\n<div align=\"center\">\n    <h1>\ud83d\udc0d JUPITER PYTHON SDK \ud83e\ude90</h1>\n    <img src=\"https://github.com/0xTaoDev/jupiter-python-sdk/blob/main/images/jupiter-python-sdk-banner.png?raw=true\" width=\"75%\" height=\"75%\">\n</div>\n\n---\n\n<p align=\"center\">\n    <img src=\"https://img.shields.io/github/stars/0xtaodev/jupiter-python-sdk\">\n    <img src=\"https://img.shields.io/github/forks/0xtaodev/jupiter-python-sdk\">\n    <br>\n    <img src=\"https://img.shields.io/github/issues/0xtaodev/jupiter-python-sdk\">\n    <img src=\"https://img.shields.io/github/issues-closed/0xtaodev/jupiter-python-sdk\">\n    <br>\n    <img src=\"https://img.shields.io/github/languages/top/0xtaodev/jupiter-python-sdk\">\n    <img src=\"https://img.shields.io/github/last-commit/0xtaodev/jupiter-python-sdk\">\n    <br>\n</p>\n\n# \ud83d\udcd6 Introduction\n**Jupiter Python SDK** is a Python library that allows you to use most of **[Jupiter](https://jup.ag/) features**.<br>\nIt enables executing swaps, limit orders, DCA, swap pairs, tokens prices, fetching wallet infos, stats, data and more!<br>\nThis library is using packages like: [solana-py](https://github.com/michaelhly/solana-py), [solders](https://github.com/kevinheavey/solders), [anchorpy](https://github.com/kevinheavey/anchorpy).<br>\nThere is documentation inside each function, however, you can access to the [official Jupiter API](https://docs.jup.ag/docs) for more information.\n\n# \u26a0\ufe0f Disclaimer\n**Please note that I'm not responsible for any loss of funds, damages, or other libailities resulting from the use of this software or any associated services.<br>\nThis tool is provided for educational purposes only and should not be used as financial advice, it is still in expiremental phase so use it at your own risk.**\n\n# \u2728 Quickstart\n\n### \ud83d\udee0\ufe0f Installation\n\n```sh\npip install jupiter-python-sdk\n```\n\n### \ud83d\udcc3 General Usage\n**Providing the private key and RPC client is not mandatory if you only intend to execute functions for retrieving data.<br>\nOtherwise, this is required, for instance, to open a DCA account or to close one.**\n\n**You can set custom URLs for any self-hosted Jupiter APIs. Like the [V6 Swap API](https://station.jup.ag/docs/apis/self-hosted) or [QuickNode's Metis API](https://marketplace.quicknode.com/add-on/metis-jupiter-v6-swap-api).**\n\nIf you encounter ```ImportError: cannot import name 'sync_native' from 'spl.token.instructions``` error when trying to import Jupiter, Jupiter_DCA from jupiter_python_sdk.jupiter, follow these steps:\n1. Go to https://github.com/michaelhly/solana-py/tree/master/src/spl/token and download ```instructions.py```\n2. In your packages folder, replace ```spl/token/instructions.py``` with the one you just downloaded.\n\n### Here is a code snippet on how to use the SDK\n```py\nimport base58\nimport base64\nimport json\n\nfrom solders import message\nfrom solders.pubkey import Pubkey\nfrom solders.keypair import Keypair\nfrom solders.transaction import VersionedTransaction\n\nfrom solana.rpc.types import TxOpts\nfrom solana.rpc.async_api import AsyncClient\nfrom solana.rpc.commitment import Processed\n\nfrom jupiter_python_sdk.jupiter import Jupiter, Jupiter_DCA\n\n\nprivate_key = Keypair.from_bytes(base58.b58decode(os.getenv(\"PRIVATE-KEY\"))) # Replace PRIVATE-KEY with your private key as string\nasync_client = AsyncClient(\"SOLANA-RPC-ENDPOINT-URL\") # Replace SOLANA-RPC-ENDPOINT-URL with your Solana RPC Endpoint URL\njupiter = Jupiter(\n    async_client=async_client,\n    keypair=private_key,\n    quote_api_url=\"https://quote-api.jup.ag/v6/quote?\",\n    swap_api_url=\"https://quote-api.jup.ag/v6/swap\",\n    open_order_api_url=\"https://jup.ag/api/limit/v1/createOrder\",\n    cancel_orders_api_url=\"https://jup.ag/api/limit/v1/cancelOrders\",\n    query_open_orders_api_url=\"https://jup.ag/api/limit/v1/openOrders?wallet=\",\n    query_order_history_api_url=\"https://jup.ag/api/limit/v1/orderHistory\",\n    query_trade_history_api_url=\"https://jup.ag/api/limit/v1/tradeHistory\"\n)\n\n\n\"\"\"\nEXECUTE A SWAP\n\"\"\"\ntransaction_data = await jupiter.swap(\n    input_mint=\"So11111111111111111111111111111111111111112\",\n    output_mint=\"EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v\",\n    amount=5_000_000,\n    slippage_bps=1,\n)\n# Returns str: serialized transactions to execute the swap.\n\nraw_transaction = VersionedTransaction.from_bytes(base64.b64decode(transaction_data))\nsignature = private_key.sign_message(message.to_bytes_versioned(raw_transaction.message))\nsigned_txn = VersionedTransaction.populate(raw_transaction.message, [signature])\nopts = TxOpts(skip_preflight=False, preflight_commitment=Processed)\nresult = await async_client.send_raw_transaction(txn=bytes(signed_txn), opts=opts)\ntransaction_id = json.loads(result.to_json())['result']\nprint(f\"Transaction sent: https://explorer.solana.com/tx/{transaction_id}\")\n\n\n\"\"\"\nOPEN LIMIT ORDER\n\"\"\"\ntransaction_data = await jupiter.open_order(\n    input_mint=So11111111111111111111111111111111111111112\",\n    output_mint=EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v\",\n    in_amount=5_000_000,\n    out_amount=100_000,\n)\n# Returns dict: {'transaction_data': serialized transactions to create the limit order, 'signature2': signature of the account that will be opened}\n\nraw_transaction = VersionedTransaction.from_bytes(base64.b64decode(transaction_data['transaction_data']))\nsignature = private_key.sign_message(message.to_bytes_versioned(raw_transaction.message))\nsigned_txn = VersionedTransaction.populate(raw_transaction.message, [signature, transaction_data['signature2']])\nopts = TxOpts(skip_preflight=False, preflight_commitment=Processed)\nresult = await async_client.send_raw_transaction(txn=bytes(signed_txn), opts=opts)\ntransaction_id = json.loads(result.to_json())['result']\nprint(f\"Transaction sent: https://explorer.solana.com/tx/{transaction_id}\")\n\n\n\"\"\"\nCREATE DCA ACCOUNT\n\"\"\"\ncreate_dca_account = await jupiter.dca.create_dca(\n    input_mint=Pubkey.from_string(\"So11111111111111111111111111111111111111112\"),\n    output_mint=Pubkey.from_string(\"EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v\"),\n    total_in_amount=5_000_000,\n    in_amount_per_cycle=100_000,\n    cycle_frequency=60,\n    min_out_amount_per_cycle=0,\n    max_out_amount_per_cycle=0,\n    start=0\n)\n# Returns DCA Account Pubkey and transaction hash.\n\n\n\"\"\"\nCLOSE DCA ACCOUNT\n\"\"\"\nclose_dca_account = await jupiter.dca.close_dca(\n    dca_pubkey=Pubkey.from_string(\"45iYdjmFUHSJCQHnNpWNFF9AjvzRcsQUP9FDBvJCiNS1\")\n)\n# Returns transaction hash.\n```\n\n### \ud83d\udcdc All available features\n```py\n- quote\n- swap\n- open_order\n- cancel_orders\n- create_dca\n- close_dca\n- fetch_user_dca_accounts\n- fetch_dca_account_fills_history\n- get_available_dca_tokens\n- fetch_dca_data\n- query_open_orders\n- query_orders_history\n- query_trades_history\n- get_jupiter_stats\n- get_token_price\n- get_indexed_route_map\n- get_tokens_list\n- get_all_tickers\n- get_all_swap_pairs\n- get_swap_pairs\n- get_token_stats_by_date\n- program_id_to_label\n```\n\n# \ud83d\udcdd TO-DO\n- [ ] Bridge \ud83c\udf09\n- [ ] Perpetual \ud83d\udcb8\n\n# \ud83e\udd1d Contributions\nIf you are interesting in contributing, fork the repository and submit a pull request in order to merge your improvements into the main repository.<br>\nContact me for any inquiry, I will reach you as soon as possible.<br>\n[![Discord](https://img.shields.io/badge/Discord-%237289DA.svg?logo=discord&logoColor=white)](https://discord.gg/QxwPGcXDp7)\n[![Twitter](https://img.shields.io/badge/Twitter-%231DA1F2.svg?logo=Twitter&logoColor=white)](https://twitter.com/_TaoDev_)\n\n# \ud83d\udc51 Donations\nThis project doesn't include platform fees. If you find value in it and would like to support its development, your donations are greatly appreciated.<br>\n**SOLANA ADDRESS**\n```sh\nAyWu89SjZBW1MzkxiREmgtyMKxSkS1zVy8Uo23RyLphX\n```\n",
    "bugtrack_url": null,
    "license": "LICENSE.txt",
    "summary": "Jupiter Python SDK",
    "version": "0.0.2.2",
    "project_urls": null,
    "split_keywords": [
        "python",
        " solana",
        " jupiter",
        " dex",
        " trading",
        " sdk"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "cb13c65e68117fb0ceaa3cceecbd6a0caf8d925bf07e55921a9d32d5eb84b8e8",
                "md5": "bac0244c8cc9304a457d54c7ae2b6eee",
                "sha256": "8af6f53e1ddd360a3e6562ac005635d6a64d324438f2f9e455a8e29c090e071c"
            },
            "downloads": -1,
            "filename": "jupiter_python_sdk_public-0.0.2.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "bac0244c8cc9304a457d54c7ae2b6eee",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 19962,
            "upload_time": "2025-01-09T08:59:51",
            "upload_time_iso_8601": "2025-01-09T08:59:51.827388Z",
            "url": "https://files.pythonhosted.org/packages/cb/13/c65e68117fb0ceaa3cceecbd6a0caf8d925bf07e55921a9d32d5eb84b8e8/jupiter_python_sdk_public-0.0.2.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "96ceb3317f4fe5b8393ed1501334609e93b97d21333e893fdcb48256c117c823",
                "md5": "31c6dfc2c25d649fcd7a0220c9592c2f",
                "sha256": "52b604e90479003e55c9f950450c6740fb404ab628af4e7b6c8e69c6d7ee22c8"
            },
            "downloads": -1,
            "filename": "jupiter_python_sdk_public-0.0.2.2.tar.gz",
            "has_sig": false,
            "md5_digest": "31c6dfc2c25d649fcd7a0220c9592c2f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 22328,
            "upload_time": "2025-01-09T08:59:54",
            "upload_time_iso_8601": "2025-01-09T08:59:54.799993Z",
            "url": "https://files.pythonhosted.org/packages/96/ce/b3317f4fe5b8393ed1501334609e93b97d21333e893fdcb48256c117c823/jupiter_python_sdk_public-0.0.2.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-09 08:59:54",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "jupiter-python-sdk-public"
}
Samuel Sallee
Elapsed time: 0.44591s