Upshift Docs

How to reach the Upshift REST API — base URLs, authentication, response conventions — and where the generated endpoint reference lives.

The Upshift REST API exposes vault data, performance analytics, points, and the institutional subaccount surface over HTTP. Every endpoint page in this section is generated from the API's own OpenAPI schema, so the parameters, response shapes, and status codes you see are the ones the server actually serves.

The two surfaces

	Public API	Institutional API
Base URL	`https://api.upshift.finance/v1`	`https://api.upshift.finance/api/v1`
Auth	none	`x-api-key` header
Scope	vault listings, APY, user points	subaccounts, vault analytics, governance, protocol integrations
Schema	`/v1/openapi.json`	`/api/v1/openapi.json`

Prefer a typed client over raw HTTP where you can — the SDK quick start covers the same data with TypeScript types and multi-chain adapters.

Authentication

The public surface needs no credentials. Institutional endpoints take an API key in a header:

curl https://api.upshift.finance/api/v1/subaccounts/summary \
  -H "x-api-key: YOUR_API_KEY"

Keys are issued per integration. To call the API from a browser you also need your origin whitelisted — reach out and we will add it.

Conventions

JSON everywhere, request and response.
Multi-chain — EVM chains are the primary surface; vaults are addressed by contract address, and by chain where an endpoint spans networks.
200 on success, 422 with per-field validation detail on a malformed request.
Rate-limit state is reported in the response headers; throttle against them rather than a fixed delay.

Reading a vault

The fields integrators reach for first on a tokenized_vaults response:

Field	Meaning
`address`	Vault contract address
`vault_name`	Human-readable vault name
`status`	`active` — operational and accepting deposits; `closed` — closed to new deposits. The schema also allows `migrated`.
`chain`	Chain ID the vault is deployed on
`reported_apy`	APY figures, including the breakdown by source
`rewards`	Reward multipliers currently attached to the vault
`subaccounts`	The strategist subaccounts the vault deploys into
`is_featured`	Whether the app surfaces the vault prominently
`receipt_token_symbol`	Symbol of the vault's receipt token

Vaults you will meet in responses include cUSDO (stablecoin strategies), tETH (tokenized ETH), wstETH (wrapped staked ETH) and rsETH (restaked ETH).

curl "https://api.upshift.finance/v1/tokenized_vaults?status=active"
curl "https://api.upshift.finance/v1/tokenized_vaults/0x1234...abcd"

Trying a request

Each endpoint page carries a live playground. Requests from it route through this site's own origin to get past CORS, and nothing is stored — an authenticated endpoint still needs you to paste your own key into the form.

Deprecations

Deprecated parameters and fields are flagged inline on each endpoint page — the badge comes from the schema, so it appears the moment the API marks something. Two worth calling out because their stated removal date (2026-01-01) has already passed and they are still served: hgETH30dLiquidAPY and hgETH7dLiquidAPY. Read liquidAPY30Day and liquidAPY7Day instead.

Performance data and APY figures are informational. Verify anything you act on financially against the on-chain state.

Overview