Jupiter Ultra icon

Jupiter Ultra

Jupiter Ultra API operations
Join our community

Actions6

Overview

This node integrates with the Jupiter Ultra API, providing various operations related to token swaps and liquidity on the Solana blockchain. It allows users to:

  • Retrieve available liquidity routers.
  • Get token balances for a wallet.
  • Search tokens by symbol, name, or mint address.
  • Create swap orders by obtaining quotes and unsigned transactions.
  • Execute signed swap transactions.
  • Fetch token risk warnings.

Common scenarios include building automated workflows for decentralized finance (DeFi) applications on Solana, such as fetching token prices, performing token swaps programmatically, or monitoring wallet balances. For example, a user could automate swapping tokens based on market conditions or aggregate liquidity router information to optimize trades.

Properties

Name Meaning
Base URL The base URL of the Jupiter Ultra API endpoint. Defaults to https://lite-api.jup.ag/ultra/v1.
Operation The action to perform. Options: Balances, Execute, Order, Routers, Search, Shield.

Additional properties shown depending on selected operation:

  • Order (Create swap order):

    • Input Mint: Input token mint address.
    • Output Mint: Output token mint address.
    • Amount: Amount in smallest unit (lamports/atoms).
    • Taker: Optional taker wallet address.
    • Referral Account: Optional referral account address.
    • Referral Fee: Referral fee in basis points (0-10000), shown only if Referral Account is set.
    • Exclude Routers: Comma-separated list of routers to exclude.

  • Execute (Submit signed transaction):

    • Signed Transaction: Base64 encoded signed transaction.
    • Request ID: Request ID from the order endpoint.

  • Balances (Get token balances):

    • Address: Wallet address to get balances for.

  • Shield (Get token risk warnings):

    • Mints: Optional comma-separated list of mint addresses.

  • Search (Search tokens):

    • Search Query: Optional search query string.

Output

The node outputs an array of JSON objects corresponding to each input item processed. Each output item contains the raw JSON response from the Jupiter Ultra API for the requested operation.

  • For example, when retrieving routers, the output JSON will contain details about available liquidity routers.
  • When creating an order, the output includes quote details and an unsigned transaction.
  • Executing a transaction returns the result of submitting the signed transaction.
  • Balances return token balance information for the specified wallet.
  • Search returns matching tokens.
  • Shield returns token risk warnings.

If the node encounters an error and "Continue On Fail" is enabled, the output JSON for that item will contain an error field with the error message.

The node does not output binary data.

Dependencies

  • Requires access to the Jupiter Ultra API.
  • Optionally uses an API key credential for authenticated requests; if provided, it adds an x-api-key header.
  • No other external dependencies are required.
  • The base URL can be customized but defaults to the official Jupiter Ultra API endpoint.

Troubleshooting

  • Unknown operation error: Occurs if an unsupported operation is selected. Ensure the operation property is set correctly.
  • API request failures: Could be due to network issues, invalid parameters, or missing/invalid API key. Verify credentials and parameter correctness.
  • Invalid wallet or mint addresses: Ensure all addresses conform to Solana's expected format.
  • Referral fee errors: Referral fee must be between 0 and 10000 basis points if a referral account is specified.
  • If the node throws errors during HTTP requests, check the API status and your network connectivity.
  • Use "Continue On Fail" option to handle partial failures gracefully.

Links and References

Discussion