Skip to main content
This guide walks through your first authenticated request to the Spritz API. By the end you’ll have confirmed your credentials work and read back the authenticated user.

​
Prerequisites

  • A Spritz integrator account and credentials. See Authentication for how each credential type works and which one fits your integration.
  • A REST client (curl, Postman, or your language’s HTTP library).
Don’t have credentials yet? Get in touch to set up an integrator account and start in the sandbox.
The API base URL is https://platform.spritz.finance. All endpoints are versioned under /v1.
The API Reference is generated from the deployed production contract. For client generation or environment-specific validation, use the canonical production OpenAPI or sandbox OpenAPI directly.
These docs are machine-readable. /llms.txt indexes every page, any page is available as markdown by appending .md to its URL (for example /guides/use-cases/off-ramp.md), and the OpenAPI spec doubles as the source for generated clients — all three are handy things to hand to a coding agent.
We publish an api-client package, and we’d rather you didn’t use it right now: it’s a mix of the older and current APIs, and that seam causes more confusion than it saves. Build against the REST API documented here, and generate typed clients from the OpenAPI spec if you want them — that stays in sync with reality. The one thing the package repo is good for: it contains working TypeScript for HMAC request signing, so if you’re fighting 401s, read that code as a reference implementation. Copy the signing logic; don’t take the dependency.

​
Make your first call

GET /v1/integrator returns your integrator profile — the simplest way to confirm your credentials work, and it needs no user:
Once you’re acting for a user, GET /v1/users/me reads the authenticated user:
A successful response returns 200 OK. If the credential is missing or invalid you’ll get a 401 problem response.

​
Next steps

Authentication

Understand HMAC signing and integrator tokens.

Off-ramp to fiat

Convert stablecoins and other tokens to fiat and settle to a bank account.

Handle errors

Parse RFC 9457 problem responses consistently.

Receive webhooks

Track settlement and status changes asynchronously.