Skip to content

feat: ultra juno router endpoint #654

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 28, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 24 additions & 5 deletions docs/101-ultra-api/4-get-shield.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ This is useful when integrating with Jupiter Ultra or any other APIs, allowing y

```jsx
const shieldResponse = await (
await fetch(`https://lite-api.jup.ag/ultra/v1/shield?mints=So11111111111111111111111111111111111111112,EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v`)
await fetch(`https://lite-api.jup.ag/ultra/v1/shield?mints=So11111111111111111111111111111111111111112,EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v,DocTwz3QhCgKy1CJJMruEAFEG5xTGoC43vPMkC41pump`)
).json();
```

Expand All @@ -40,14 +40,33 @@ The shield response will return a list of token information and warnings of mint
```json
{
"warnings": {
"EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v": [
"DocTwz3QhCgKy1CJJMruEAFEG5xTGoC43vPMkC41pump": [
{
"type": "HAS_MINT_AUTHORITY",
"message": "This token has a mint authority"
"type": "NOT_VERIFIED",
"message": "This token is not verified, make sure the mint address is correct before trading",
"severity": "info"
},
{
"type": "LOW_ORGANIC_ACTIVITY",
"message": "This token has low organic activity",
"severity": "info"
},
{
"type": "NEW_LISTING",
"message": "This token is newly listed",
"severity": "info"
}
],
"EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v": [
{
"type": "HAS_FREEZE_AUTHORITY",
"message": "This token has a freeze authority"
"message": "The authority's owner has the ability to freeze your token account, preventing you from further trading",
"severity": "warning"
},
{
"type": "HAS_MINT_AUTHORITY",
"message": "The authority's owner has the ability to mint more tokens",
"severity": "info"
}
],
"So11111111111111111111111111111111111111112": []
Expand Down
64 changes: 64 additions & 0 deletions docs/api/ultra-api/routers.api.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
id: routers
title: "routers"
description: "Request for the list of routers available in the routing engine of Ultra, which is [Juno](/docs/routing#juno-liquidity-engine)"
sidebar_label: "routers"
hide_title: true
hide_table_of_contents: true
api: eJzNVEtv2zAM/iuCdlmBJE53zK3A2m7dhnWvy9IcFJuJmcqSKlFpAzf/faTtrmmLAjsuF1N88+PHtLqCVEYMhN7pmf4ONxkSqZWPimpQFvnhVyr6TBCTMluD1iwtKHSdgxjQrRW4NToQ11+Wohmp2xrLWmFS84vs/OJtUfkyFYP7mw3rxhZvMlZIu3EffXTl9EhHSMG7BEnPWv1uOpXP0yZ/5LKElFbZqgdnjiu9I3Ak7iYEi6UR92KTJKbVqayhMSLRLgBnMTGaHcchQZMO9H65gZLYEKIPEAn7TrA68EkUeQq9H2lnGnhpGGlwudGzuf4ChInfFzlwofibxQ8m1Svrb1l8fybfBefBsm/zWYG94MEoRagkGzcxlFzsu99IN0C1Z6NeQ9e0oZofhY8VxGJYG+sTxK1Is3mrc7TsUhOFNCsKy32NTcDJJoeJWRdZ9ldsjznoKexnEUAxHFGdXH7khVfBoyN1i1SraEjI0iAlRuV5iX/Jfmmwei17jeuaDQdFFHm1BJUTVL2LcV3cJ9jp/YLhdCvfwYlkBc9vGcvrRCYKRgJEX/R4Mp1MX7Ryrz6ju1b3V+5ejcfjXpifA6mvguoDl7tRBLmCoR93gB8Nvqd3UDLyr/lDbz6IESoFn6gxHQt6VunH9T1psH3k+v9wsANlCe6oCNZgN0xHgHag41x3k8pxDxPximoeV0xtuzQJfkW734uax4k71rO4NRGldXlxyhqMJBEGX/OaZ/qE/wZCt1Bjc3fSz+9eqPD3QM5Pf/JB/QGJL7cn
sidebar_class_name: "get api-method"
info_path: docs/api/ultra-api/quickstart
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
as={"h1"}
className={"openapi__heading"}
children={"routers"}
>
</Heading>

<MethodEndpoint
method={"get"}
path={"/order/routers"}
context={"endpoint"}
>

</MethodEndpoint>



Request for the list of routers available in the routing engine of Ultra, which is [Juno](/docs/routing#juno-liquidity-engine)


<ParamsDetails
parameters={undefined}
>

</ParamsDetails>

<RequestSchema
title={"Body"}
body={undefined}
>

</RequestSchema>

<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","enum":["Metis","JupiterZ","Hashflow","DFlow"]},"icon":{"type":"string"}},"required":["id","name"]}}}}}}}
>

</StatusCodes>



6 changes: 3 additions & 3 deletions docs/api/ultra-api/shield.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Request for token information and warnings of mints"
sidebar_label: "shield"
hide_title: true
hide_table_of_contents: true
api: eJzNVE1vEzEQ/SuWT62UZFMEl70VVKoKJEqhpyQHZ3eSdeO1jT2bttrmvzPjTegmaSWEkCCHje35evP8xq0sIRZBe9TOylzewI8GIoqFCwLdCqzQlta1YrtQthT3Klhtl1G4hai1xTi1U5vnuXUIUzsUN7AAjhWTW4NBifPrK1G6YnaS0TdmDR8OldfZEnAYKw2mPE3lahegXy1lnVo5kAGidzZClHkr34zH/LcP+1tTFBDjojFi50xxhbMIFtldeW90kfJmd5FjWhmLCmrFK3z0QFnc/A4KpEAfnIeAuqu46/jYc5N+A/n2JUzvVUlgEp1/DwuE4ELPLWIgaJJBcC0doJT5ZOs269C9ewndFcEJVhkRIazpwrqIf4iTLF4FVQPhohSTVmrGSfyFR0pvyULbpDjaHuHYFejnx9DA4KDvD66uFTXNtRBKYTSpfSdlli3Jck/ztJKb2UASsMpRUkkO3K7CijZZp2BGlHjskDfBkK1C9DHPMqMRWPGju8aP1LIbgWx9Jg+xfQwAghgMaWjAlt4RKnGvsRKMlsDWmtrfDA5L/E72a6XL17JXelmRoVeEqZiDaCJxlFyUTXGf4DHRwRQl+jUa5v9ro4tVRBWYHCaiK3o2Go/GR1CexGdtV+Jpap/EcDjsFpNLYv5LKCG8/FY4Np1ufS8eoGgI7Cv+0Jl7MawM7yLWKul4K6dft7eHr32egv/zQdxqHuEBM2+UTt0lRbRbYU52rdFVVdQ2n7TtXEW4DWaz4eNusliupY5qbnhiFsrEw5Hps3Fysx2uU/FHg/QK9BWJ6nm218o07JN0tlZBMzgCOiPPChTdaELdBZ3Tw++xF3X0au0N7+XFd3qEfgLz4G3A
api: eJzNVU1v2zAM/SuCTi2QxOmwXXLbhq4oNmBdt56SHBibidXYkirJaQvX/32k7DQfdbFhGLBdWtt8JB+f+JRaZuhTp2xQRsuJvMa7Cn0QS+NEMGvUQml6LoHjAnQm7sFppVdemKUolQ5+poWY6clkok3AmR6Ka1wiZ4vpTREciPdXlyIz6fwkob8+qfjjEKxKVhiGPldYZKexYWkc7veLVWdaDqRDb4326OWklm/GY/53SPx7labo/bIqxBZMeanRAXVgOFhbqDTWTW4959TSpzmWwE/h0SJVMYtbTAMlWmcsuqDajtuZ+5CQZYqLQnF1kNPhwDl4JJgKWPbm256sZ5QPjvrKZiBLGg5WfbGG5bmrlMNMTqZtdIefN80x4nmaLva2T88PkAnXLsPf0xGdM+7XI7Swjt27PnaXRMeR5MKj29CytRn/kCdFLDgokXhRiWktFfMk/RyfvqYIvUa/0OsLHrtz3tUPrsLB0dwfTVkCDc29AmaiUOTVrRHZcmSpA8fSk2zmvA4hN1RUEoDHhZDTS9K6jxlFHVvmlSsolodg/SRJCtpcduvotrIjWLX2TTZn8pjbJ4coSEEXDY86s4ZYiXsVcsFsiWypaPxmcNzid6pfgcpeq56rVU6BvSYsxQJF5UmjCAEd8z7jY5SDJYryq1Cw/t8qla59AMfisBBt07PReDR+QeVJfFF6LZ5m+kkMh8P2YXpByn91Gbr+e85w6LTDnj9gWhHZV/DYhvdyeDOs8aGEuMfdOj2f3gG/eueC//U677Y+4ENIbAEqzhd3ou5Wc7odjg4rp8H5S10vwOONK5qGP7fe4oXNlIdFwZ5ZQuGPTbOvx8l1Z69T8UdWeoX6mtZq5+4NFBVj4qZtwCkmR0TnhMwR6Ewj6zbpPf1s2bCX9eLeOrDvxfkPuoZ+AinQr/w=
sidebar_class_name: "get api-method"
info_path: docs/api/ultra-api/quickstart
custom_edit_url: null
Expand Down Expand Up @@ -37,7 +37,7 @@ import Heading from "@theme/Heading";


Request for token information and warnings of mints

:::note
- Refer to [Ultra API doc](/docs/ultra-api/get-shield) for more information
:::
Expand Down Expand Up @@ -67,7 +67,7 @@ Request for token information and warnings of mints
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"warnings":{"type":"object"}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}}}}
responses={{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"warnings":{"type":"object","additionalProperties":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string"}},"required":["type","message"]}}}},"required":["warnings"]}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}}}}
>

</StatusCodes>
Expand Down
47 changes: 45 additions & 2 deletions openapi/ultra.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -406,7 +406,7 @@ paths:
summary: shield
description: |
Request for token information and warnings of mints

:::note
- Refer to [Ultra API doc](/docs/ultra-api/get-shield) for more information
:::
Expand All @@ -420,6 +420,20 @@ paths:
properties:
warnings:
type: object
additionalProperties:
type: array
items:
type: object
properties:
type:
type: string
message:
type: string
required:
- type
- message
required:
- warnings
'400':
description: Bad request
content:
Expand Down Expand Up @@ -448,4 +462,33 @@ paths:
schema:
type: string
required: true
description: "Comma separated list of mints to get information for"
description: "Comma separated list of mints to get information for"
/order/routers:
get:
summary: routers
description: |
Request for the list of routers available in the routing engine of Ultra, which is [Juno](/docs/routing#juno-liquidity-engine)
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: string
name:
type: string
enum:
- Metis
- JupiterZ
- Hashflow
- DFlow
icon:
type: string
required:
- id
- name
4 changes: 4 additions & 0 deletions sidebars-api.js
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,10 @@ const sidebars = {
type: 'doc',
id: 'api/ultra-api/shield',
},
{
type: 'doc',
id: 'api/ultra-api/routers',
},
],
},
{
Expand Down