Class DefaultApi

Hierarchy (view full)

BaseAPI
- DefaultApi

Index

Constructors

Properties

Methods

indexedRouteMapGet indexedRouteMapGetRaw isJsonMime programIdToLabelGet programIdToLabelGetRaw quoteGet quoteGetRaw request swapInstructionsPost swapInstructionsPostRaw swapPost swapPostRaw tokensGet tokensGetRaw withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

new DefaultApi(configuration?): DefaultApi
Parameters
- configuration: Configuration = DefaultConfig
Returns DefaultApi
Inherited from BaseAPI.constructor
- Defined in wtfdocs/jupiter-quote-api-node/generated/runtime.ts:97

Properties

`Protected`configuration

configuration: Configuration = DefaultConfig

Methods

indexedRouteMapGet

indexedRouteMapGet(requestParameters?, initOverrides?): Promise<IndexedRouteMapResponse>
DEPRECATED, please use /tokens for tradable mints. Returns a hash map, input mint as key and an array of valid output mint as values, token mints are indexed to reduce the file size GET /indexed-route-map
Parameters
- requestParameters: IndexedRouteMapGetRequest = {}
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<IndexedRouteMapResponse>
Deprecated
- Defined in wtfdocs/jupiter-quote-api-node/generated/apis/DefaultApi.ts:104

indexedRouteMapGetRaw

indexedRouteMapGetRaw(requestParameters, initOverrides?): Promise<ApiResponse<IndexedRouteMapResponse>>
DEPRECATED, please use /tokens for tradable mints. Returns a hash map, input mint as key and an array of valid output mint as values, token mints are indexed to reduce the file size GET /indexed-route-map
Parameters
- requestParameters: IndexedRouteMapGetRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<IndexedRouteMapResponse>>
Deprecated
- Defined in wtfdocs/jupiter-quote-api-node/generated/apis/DefaultApi.ts:80

`Protected`isJsonMime

isJsonMime(mime): boolean
Check if the given MIME is a JSON MIME. JSON MIME examples: application/json application/json; charset=UTF8 APPLICATION/JSON application/vnd.company+json
Parameters
- mime: undefined | null | string
  MIME (Multipurpose Internet Mail Extensions)
Returns boolean
True if the given MIME is JSON, false otherwise.
Inherited from BaseAPI.isJsonMime
- Defined in wtfdocs/jupiter-quote-api-node/generated/runtime.ts:127

programIdToLabelGet

programIdToLabelGet(initOverrides?): Promise<{
[key: string]: string;
}>
Returns a hash, which key is the program id and value is the label. This is used to help map error from transaction by identifying the fault program id. With that, we can use the excludeDexes or dexes parameter. GET /program-id-to-label
Parameters
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<{
[key: string]: string;
}>
- Defined in wtfdocs/jupiter-quote-api-node/generated/apis/DefaultApi.ts:132

programIdToLabelGetRaw

programIdToLabelGetRaw(initOverrides?): Promise<ApiResponse<{
[key: string]: string;
}>>
Returns a hash, which key is the program id and value is the label. This is used to help map error from transaction by identifying the fault program id. With that, we can use the excludeDexes or dexes parameter. GET /program-id-to-label
Parameters
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<{
[key: string]: string;
}>>
- Defined in wtfdocs/jupiter-quote-api-node/generated/apis/DefaultApi.ts:113

quoteGet

quoteGet(requestParameters, initOverrides?): Promise<QuoteResponse>
Sends a GET request to the Jupiter API to get the best priced quote. GET /quote
Parameters
- requestParameters: QuoteGetRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<QuoteResponse>
- Defined in wtfdocs/jupiter-quote-api-node/generated/apis/DefaultApi.ts:244

quoteGetRaw

quoteGetRaw(requestParameters, initOverrides?): Promise<ApiResponse<QuoteResponse>>
Sends a GET request to the Jupiter API to get the best priced quote. GET /quote
Parameters
- requestParameters: QuoteGetRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<QuoteResponse>>
- Defined in wtfdocs/jupiter-quote-api-node/generated/apis/DefaultApi.ts:141

`Protected`request

request(context, initOverrides?): Promise<Response>
Parameters
- context: RequestOpts
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<Response>
Inherited from BaseAPI.request
- Defined in wtfdocs/jupiter-quote-api-node/generated/runtime.ts:134

swapInstructionsPost

swapInstructionsPost(requestParameters, initOverrides?): Promise<SwapInstructionsResponse>
Returns instructions that you can use from the quote you get from /quote. POST /swap-instructions
Parameters
- requestParameters: SwapInstructionsPostRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<SwapInstructionsResponse>
- Defined in wtfdocs/jupiter-quote-api-node/generated/apis/DefaultApi.ts:279

swapInstructionsPostRaw

swapInstructionsPostRaw(requestParameters, initOverrides?): Promise<ApiResponse<SwapInstructionsResponse>>
Returns instructions that you can use from the quote you get from /quote. POST /swap-instructions
Parameters
- requestParameters: SwapInstructionsPostRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<SwapInstructionsResponse>>
- Defined in wtfdocs/jupiter-quote-api-node/generated/apis/DefaultApi.ts:253

swapPost

swapPost(requestParameters, initOverrides?): Promise<SwapResponse>
Returns a transaction that you can use from the quote you get from /quote. POST /swap
Parameters
- requestParameters: SwapPostRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<SwapResponse>
- Defined in wtfdocs/jupiter-quote-api-node/generated/apis/DefaultApi.ts:314

swapPostRaw

swapPostRaw(requestParameters, initOverrides?): Promise<ApiResponse<SwapResponse>>
Returns a transaction that you can use from the quote you get from /quote. POST /swap
Parameters
- requestParameters: SwapPostRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<SwapResponse>>
- Defined in wtfdocs/jupiter-quote-api-node/generated/apis/DefaultApi.ts:288

tokensGet

tokensGet(initOverrides?): Promise<string[]>
Returns a list of all the tradable mints GET /tokens
Parameters
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<string[]>
- Defined in wtfdocs/jupiter-quote-api-node/generated/apis/DefaultApi.ts:342

tokensGetRaw

tokensGetRaw(initOverrides?): Promise<ApiResponse<string[]>>
Returns a list of all the tradable mints GET /tokens
Parameters
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<string[]>>
- Defined in wtfdocs/jupiter-quote-api-node/generated/apis/DefaultApi.ts:323

withMiddleware

withMiddleware<T>(this, ...middlewares): T
Type Parameters
- T extends BaseAPI
Parameters
- this: T
- Rest...middlewares: Middleware[]
Returns T
Inherited from BaseAPI.withMiddleware
- Defined in wtfdocs/jupiter-quote-api-node/generated/runtime.ts:101

withPostMiddleware

withPostMiddleware<T>(this, ...postMiddlewares): T
Type Parameters
- T extends BaseAPI
Parameters
- this: T
- Rest...postMiddlewares: (undefined | ((context: ResponseContext) => Promise<void | Response>))[]
Returns T
Inherited from BaseAPI.withPostMiddleware
- Defined in wtfdocs/jupiter-quote-api-node/generated/runtime.ts:112

withPreMiddleware

withPreMiddleware<T>(this, ...preMiddlewares): T
Type Parameters
- T extends BaseAPI
Parameters
- this: T
- Rest...preMiddlewares: (undefined | ((context: RequestContext) => Promise<void | FetchParams>))[]
Returns T
Inherited from BaseAPI.withPreMiddleware
- Defined in wtfdocs/jupiter-quote-api-node/generated/runtime.ts:107

Class DefaultApi

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DefaultApi

Properties

Protectedconfiguration

Methods

indexedRouteMapGet

Parameters

Returns Promise<IndexedRouteMapResponse>

Deprecated

indexedRouteMapGetRaw

Parameters

Returns Promise<ApiResponse<IndexedRouteMapResponse>>

Deprecated

ProtectedisJsonMime

Parameters

Returns boolean

programIdToLabelGet

Parameters

Returns Promise<{ [key: string]: string; }>

programIdToLabelGetRaw

Parameters

Returns Promise<ApiResponse<{ [key: string]: string; }>>

quoteGet

Parameters

Returns Promise<QuoteResponse>

quoteGetRaw

Parameters

Returns Promise<ApiResponse<QuoteResponse>>

Protectedrequest

Parameters

Returns Promise<Response>

swapInstructionsPost

Parameters

Returns Promise<SwapInstructionsResponse>

swapInstructionsPostRaw

Parameters

Returns Promise<ApiResponse<SwapInstructionsResponse>>

swapPost

Parameters

Returns Promise<SwapResponse>

swapPostRaw

Parameters

Returns Promise<ApiResponse<SwapResponse>>

tokensGet

Parameters

Returns Promise<string[]>

tokensGetRaw

Parameters

Returns Promise<ApiResponse<string[]>>

withMiddleware

Type Parameters

Parameters

Returns T

withPostMiddleware

Type Parameters

Parameters

Returns T

withPreMiddleware

Type Parameters

Parameters

Returns T

Settings

On This Page

`Protected`configuration

`Protected`isJsonMime

Returns Promise<{
[key: string]: string;
}>

Returns Promise<ApiResponse<{
[key: string]: string;
}>>

`Protected`request