docs: regroup API reference under "Sprinter API" tab (Credit / Liquidity / Swaps)#212
Merged
Conversation
…ity / Swaps) - Rename the second top tab "Sprinter Credit (V2) API" -> "Sprinter API" and broaden its url to api-reference so all API specs nest under it. - Group endpoints by Credit / Liquidity / Swaps, each with Info/Actions subgroups (collapsible) and an Overview landing page. - Liquidity: publish the full sprinter/liquidity endpoint set (previously unwired) + solver-address + health; short sidebar labels, long page titles. - Swaps: restore GET /v2/route (getRouteV2) from the original Blanc spec (X-API-Key auth, snake_case params, RouteResponseV2); drop the stale /v1/route. - Strip leading "Get" from API sidebar labels for consistency. - Add Overview pages for Liquidity and Swaps; rename Credit overview to "Overview". - Register solve/openapi.yaml; drop the redundant stash spec from nav. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…nav groups
- Sync Liquidity endpoints to the live api.sprinter.tech spec: fix the events
endpoint (/liquidity/protocol/{protocol}/events with a protocol path param;
was the non-existent /liquidity/pools/events).
- Remove the V1 unlock call (/liquidity/v1/.../unlock) from spec, page, and nav.
- Reframe the Liquidity overview around Sprinter Intent Liquidity (accessed via
a supported intent protocol) + add a zero-collateral / escrow-secured note.
- Give every API subgroup a unique name (Credit/Liquidity/Swap + Info/Actions)
to fix the shared collapse-state bug where same-named groups toggled together.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
Author
|
@mpetrunic Tried to make the API docs a bit easier to graps and bring back the Swap API. Can you give it some eyes pls? |
mpetrunic
reviewed
Jun 11, 2026
| description: Mainnet Swap API | ||
| - url: https://swaps.sprinter.tech/base | ||
| description: Base Swap API | ||
| - ApiKeyAuth: [] |
Member
There was a problem hiding this comment.
from what ralph sent me, it uses basic auth, not api key auth
| - in: query | ||
| name: slippageBps | ||
| description: The slippage tolerance in basis points (e.g., 50 for 0.5%) | ||
| name: slippage |
Member
There was a problem hiding this comment.
ralph sent me example where param is slippageBps
…e, /v1/route) Replace the fabricated /v2/route spec with the authoritative spec from sprintertech/ass/swap/openapi.yml. Addresses review feedback: - Basic auth instead of X-API-Key - camelCase params; slippageBps (basis points) instead of slippage float - real endpoint GET /v1/route with RouteV1Response fields Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
alexmmueller
force-pushed
the
docs/api-tab-grouping
branch
from
17244db to
683912f
Compare
Populates amountIn/tokenIn/tokenOut so Mintlify generates complete, runnable request snippets (curl, Python, JS, etc.) on the Route page instead of only slippageBps. Uses canonical mainnet USDC -> WETH to match the default mainnet server. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Parameter-level example values were ignored by Mintlify's code-sample generator; move them into the schema so amountIn/tokenIn/tokenOut appear in the generated request examples. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
Author
|
@mpetrunic & @wesraph I think the APIs are documented properly now, can you pls review! |
mpetrunic
approved these changes
Jun 11, 2026
3 tasks
Liquidity endpoints require an API key in the X-Auth-Token header. - openapi.json: add ApiKeyAuth (apiKey, X-Auth-Token, header) security scheme and apply it to all six liquidity operations (tokens, pools, events, fees, quote, signature). - liquidity/overview.mdx: add an Authentication section with a sample request and how to request credentials (support@sprinter.tech), mirroring the Swap API overview. - Add the X-Auth-Token header to every RequestExample (curl/Python/JS/Go) on the six liquidity endpoint pages; convert Go GET/POST helpers to http.NewRequest so the header can be set. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
Author
|
@mpetrunic I think now all should be fixed, also added the auth for Liquidity API. Can you do last check pls? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Restructures the API reference into a single Sprinter API tab grouped by Credit / Liquidity / Swaps, and syncs the Liquidity endpoints to the live
api.sprinter.techspec. Worked from currentmain(not the larger restructure draft).Navigation
Sprinter Credit (V2) API→ Sprinter API; broadened its url toapi-referenceso all specs nest under it.Credit Info/Actions/Advanced,Liquidity Info/Actions,Swap Actions) — this fixes a collapse bug where same-named groups toggled together.sidebarTitle, long descriptive page titles.Liquidity (synced to live spec)
/liquidity/protocol/{protocol}/events(was the non-existent/liquidity/pools/events)./liquidity/v1/.../unlock).api.sprinter.techendpoint.Swaps
GET /v2/route(getRouteV2) from the original Blanc spec —X-API-Keyauth, snake_case params,RouteResponseV2. Lives onswaps.sprinter.tech(separate fromapi.sprinter.tech).Reviewer notes
mintlify dev— all pages render.🤖 Generated with Claude Code