- Jupiter

Jupiter (https://jup.ag) is one of the most popular DEX on Solana ecosystem with an active community, the cats! The platform provides many useful services directly from the site, but it also gives the possibility to other developers to create new powerful tools via the many open to use API endopints. Jupiter's documentation is well written and can be access from here.

The API connector is Jupiter class imported from cyhole.jupiter path.

Quick Examples

Get Latest Token Price

Extract the latest JUP buy price over USDC in few lines of code by using get_price in asynchronous logic.

import asyncio
from cyhole.jupiter import Jupiter
from cyhole.core.token.solana import JUP

# get current price of JUP on Solana
async def main() -> None:
    jupiter = Jupiter()
    async with jupiter.async_client as client:
        response = await client.get_price([JUP.address])
        print("Current JUP/USDC:", response.data[JUP.address].price)

asyncio.run(main())

Create Limit Order Transaction

Get the transaction for the creation of a new Limit Order by using post_limit_order_create in synchronous logic.

from solders.keypair import Keypair

from cyhole.jupiter import Jupiter
from cyhole.jupiter.schema import PostLimitOrderCreateBody
from cyhole.core.token.solana import JUP, USDC

jupiter = Jupiter()

# create body for the request
key = Keypair()
body = PostLimitOrderCreateBody(
    user_public_key = "YOUR-WALLET-PUBLIC-KEY",
    input_amount = 100_000,
    output_amount = 100_000,
    input_token = USDC.address,
    output_token = JUP.address,
    base = str(key.pubkey())
)

# send request
response = jupiter.client.post_limit_order_create(body)
print("Transaction:", response.transaction)

Info

The transaction should be then signed and sent on RPC to be validated and executed.

Content

The documentation follows the library's structure by providing all the technical details required to use it.

• Connector

  ---

  cyhole.jupiter - Explore the Jupiter API connector and all its methods.

  Reference

• API Parameters

  ---

  cyhole.jupiter.param - Ensure to use the correct parameters during the API calls.

  Reference

• Response Schema

  ---

  cyhole.jupiter.schema - Extract only what is necessary by exploiting reponse mapping thanks to pydantic schemes.

  Reference

• Exceptions

  ---

  cyhole.jupiter.exception - Make sure you intercept all exceptions correctly.

  Reference

Endpoints

Endpoint	Type	Method	cyhole Release	Deprecated
Price	GET	get_price	0.1.0	-
Quote	GET	get_quote	0.1.0	-
Quote Tokens	GET	get_quote_tokens	0.1.0	-
Quote Program ID to Label	GET	get_quote_program_id_label	0.1.0	-
Swap	POST	post_swap	0.1.0	-
Token Info	GET	get_token_info	0.2.5	-
Token List	GET	get_token_list	0.1.0	-
Limit Order - Create	POST	post_limit_order_create	0.1.0	-
Limit Order - Cancel	POST	post_limit_order_cancel	0.1.0	-
Limit Order - Open	GET	get_limit_order_open	0.1.0	-
Limit Order - History	GET	get_limit_order_history	0.1.0	-
Limit Order - Trade History	GET	get_limit_order_trade_history	0.1.0	-