Parameters

Some endpoints require input parameters belonging to specific domains.
On this page, all domains can be found in order to be in line with the standards required by the API.

cyhole.jupiter.param

JupiterApiTier

Bases: CyholeParam

              flowchart TD
              cyhole.jupiter.param.JupiterApiTier[JupiterApiTier]
              cyhole.core.param.CyholeParam[CyholeParam]

                              cyhole.core.param.CyholeParam --> cyhole.jupiter.param.JupiterApiTier
                


              click cyhole.jupiter.param.JupiterApiTier href "" "cyhole.jupiter.param.JupiterApiTier"
              click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
            

Enum class to get the supported Jupiter's API tiers.

JupiterSwapMode

Bases: CyholeParam

              flowchart TD
              cyhole.jupiter.param.JupiterSwapMode[JupiterSwapMode]
              cyhole.core.param.CyholeParam[CyholeParam]

                              cyhole.core.param.CyholeParam --> cyhole.jupiter.param.JupiterSwapMode
                


              click cyhole.jupiter.param.JupiterSwapMode href "" "cyhole.jupiter.param.JupiterSwapMode"
              click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
            

Enum class to get the supported Jupiter's swap modes.

JupiterSwapType

Bases: CyholeParam

              flowchart TD
              cyhole.jupiter.param.JupiterSwapType[JupiterSwapType]
              cyhole.core.param.CyholeParam[CyholeParam]

                              cyhole.core.param.CyholeParam --> cyhole.jupiter.param.JupiterSwapType
                


              click cyhole.jupiter.param.JupiterSwapType href "" "cyhole.jupiter.param.JupiterSwapType"
              click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
            

Enum class to get the supported Jupiter's swap types.

JupiterSwapExecutionStatus

Bases: CyholeParam

              flowchart TD
              cyhole.jupiter.param.JupiterSwapExecutionStatus[JupiterSwapExecutionStatus]
              cyhole.core.param.CyholeParam[CyholeParam]

                              cyhole.core.param.CyholeParam --> cyhole.jupiter.param.JupiterSwapExecutionStatus
                


              click cyhole.jupiter.param.JupiterSwapExecutionStatus href "" "cyhole.jupiter.param.JupiterSwapExecutionStatus"
              click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
            

Enum class to get the supported Jupiter's swap execution statuses.

JupiterSwapDex

Bases: CyholeParam

              flowchart TD
              cyhole.jupiter.param.JupiterSwapDex[JupiterSwapDex]
              cyhole.core.param.CyholeParam[CyholeParam]

                              cyhole.core.param.CyholeParam --> cyhole.jupiter.param.JupiterSwapDex
                


              click cyhole.jupiter.param.JupiterSwapDex href "" "cyhole.jupiter.param.JupiterSwapDex"
              click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
            

Enum class to get the supported Jupiter's swap DEXes.

JupiterOrderStatus

Bases: CyholeParam

              flowchart TD
              cyhole.jupiter.param.JupiterOrderStatus[JupiterOrderStatus]
              cyhole.core.param.CyholeParam[CyholeParam]

                              cyhole.core.param.CyholeParam --> cyhole.jupiter.param.JupiterOrderStatus
                


              click cyhole.jupiter.param.JupiterOrderStatus href "" "cyhole.jupiter.param.JupiterOrderStatus"
              click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
            

Enum class to get the supported Jupiter's order statuses.

ACTIVE class-attribute instance-attribute

ACTIVE = 'active'

The order is active.

HISTORY class-attribute instance-attribute

HISTORY = 'history'

The order is in history.

JupiterOrderState

Bases: CyholeParam

              flowchart TD
              cyhole.jupiter.param.JupiterOrderState[JupiterOrderState]
              cyhole.core.param.CyholeParam[CyholeParam]

                              cyhole.core.param.CyholeParam --> cyhole.jupiter.param.JupiterOrderState
                


              click cyhole.jupiter.param.JupiterOrderState href "" "cyhole.jupiter.param.JupiterOrderState"
              click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
            

Enum class to get the supported Jupiter's order states.

OPEN class-attribute instance-attribute

OPEN = 'Open'

The order is still open.

COMPLETED class-attribute instance-attribute

COMPLETED = 'Completed'

The order is completed.

CANCELLED class-attribute instance-attribute

CANCELLED = 'Cancelled'

The order was cancelled.

CLOSE class-attribute instance-attribute

CLOSE = 'Close'

The order was closed.

JupiterTokenTagType

Bases: CyholeParam

              flowchart TD
              cyhole.jupiter.param.JupiterTokenTagType[JupiterTokenTagType]
              cyhole.core.param.CyholeParam[CyholeParam]

                              cyhole.core.param.CyholeParam --> cyhole.jupiter.param.JupiterTokenTagType
                


              click cyhole.jupiter.param.JupiterTokenTagType href "" "cyhole.jupiter.param.JupiterTokenTagType"
              click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
            

Enum class to get the supported Jupiter's token tag types.

LST class-attribute instance-attribute

LST = 'lst'

Latest tokens added to Jupiter.

VERIFIED class-attribute instance-attribute

VERIFIED = 'verified'

A list of verified tokens, consisting of community-verified tokens via catdetlist.jup.ag and the previous standard of Jupiter Strict.

STOCKS class-attribute instance-attribute

STOCKS = 'stocks'

Tokenised real-world stocks available on Jupiter.

JupiterTokenCategory

Bases: CyholeParam

              flowchart TD
              cyhole.jupiter.param.JupiterTokenCategory[JupiterTokenCategory]
              cyhole.core.param.CyholeParam[CyholeParam]

                              cyhole.core.param.CyholeParam --> cyhole.jupiter.param.JupiterTokenCategory
                


              click cyhole.jupiter.param.JupiterTokenCategory href "" "cyhole.jupiter.param.JupiterTokenCategory"
              click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
            

Enum class to get the supported Jupiter's token category types.

JupiterTokenInterval

Bases: CyholeParam

              flowchart TD
              cyhole.jupiter.param.JupiterTokenInterval[JupiterTokenInterval]
              cyhole.core.param.CyholeParam[CyholeParam]

                              cyhole.core.param.CyholeParam --> cyhole.jupiter.param.JupiterTokenInterval
                


              click cyhole.jupiter.param.JupiterTokenInterval href "" "cyhole.jupiter.param.JupiterTokenInterval"
              click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
            

Enum class to get the supported Jupiter's token interval types.

JupiterRecurringType

Bases: CyholeParam

              flowchart TD
              cyhole.jupiter.param.JupiterRecurringType[JupiterRecurringType]
              cyhole.core.param.CyholeParam[CyholeParam]

                              cyhole.core.param.CyholeParam --> cyhole.jupiter.param.JupiterRecurringType
                


              click cyhole.jupiter.param.JupiterRecurringType href "" "cyhole.jupiter.param.JupiterRecurringType"
              click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
            

Enum class to get the supported Jupiter's recurring order types, that can be used in "Recurring - Orders" endpoint.

ALL class-attribute instance-attribute

ALL = 'all'

All recurring orders.

PRICE class-attribute instance-attribute

PRICE = 'price'

Recurring price-based orders.

TIME class-attribute instance-attribute

TIME = 'time'

Recurring time-based orders.

JupiterOrganicScore

Bases: CyholeParam

              flowchart TD
              cyhole.jupiter.param.JupiterOrganicScore[JupiterOrganicScore]
              cyhole.core.param.CyholeParam[CyholeParam]

                              cyhole.core.param.CyholeParam --> cyhole.jupiter.param.JupiterOrganicScore
                


              click cyhole.jupiter.param.JupiterOrganicScore href "" "cyhole.jupiter.param.JupiterOrganicScore"
              click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
            

Enum class to get the supported Jupiter's organic score types.

HIGH class-attribute instance-attribute

HIGH = 'high'

Tokens with high organic score.

MEDIUM class-attribute instance-attribute

MEDIUM = 'medium'

Tokens with medium organic score.

LOW class-attribute instance-attribute

LOW = 'low'

Tokens with low organic score.

JupiterBroadcastFeeType

Bases: CyholeParam

              flowchart TD
              cyhole.jupiter.param.JupiterBroadcastFeeType[JupiterBroadcastFeeType]
              cyhole.core.param.CyholeParam[CyholeParam]

                              cyhole.core.param.CyholeParam --> cyhole.jupiter.param.JupiterBroadcastFeeType
                


              click cyhole.jupiter.param.JupiterBroadcastFeeType href "" "cyhole.jupiter.param.JupiterBroadcastFeeType"
              click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
            

Enum class to get the supported Jupiter's broadcast fee type strategies in the Swap v2 "Order" endpoint.

MAX_CAP class-attribute instance-attribute

MAX_CAP = 'maxCap'

Treat the fee as a maximum cap; actual fee may be lower.

EXACT_FEE class-attribute instance-attribute

EXACT_FEE = 'exactFee'

Use the exact fee amount specified.

JupiterRouter

Bases: CyholeParam

              flowchart TD
              cyhole.jupiter.param.JupiterRouter[JupiterRouter]
              cyhole.core.param.CyholeParam[CyholeParam]

                              cyhole.core.param.CyholeParam --> cyhole.jupiter.param.JupiterRouter
                


              click cyhole.jupiter.param.JupiterRouter href "" "cyhole.jupiter.param.JupiterRouter"
              click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
            

Enum class to get the supported Jupiter's router types.

IRIS class-attribute instance-attribute

IRIS = 'iris'

Iris router.

JUPITERZ class-attribute instance-attribute

JUPITERZ = 'jupiterz'

JupiterZ router.

DFLOW class-attribute instance-attribute

DFLOW = 'dflow'

DFlow router.

OKX class-attribute instance-attribute

OKX = 'okx'

OKX router.