# Liquidramp

> Non-custodial liquidity aggregator and routing protocol for onramp, offramp, and swap.

## Docs

- [Overview](https://docs.liquidramp.com/index.md): Non-custodial onramp, offramp, and swap for API partners.
- [Create Account](https://docs.liquidramp.com/getting-started/create-account.md): Sign up, complete KYB, and get ready to generate API keys in the partner portal.
- [Authentication](https://docs.liquidramp.com/getting-started/authentication.md): Generate API keys and HMAC-sign partner API requests.
- [Sandbox vs Production](https://docs.liquidramp.com/getting-started/sandbox-vs-production.md): Test and live hosts, key prefixes, and `/v1` versioning.
- [Going Live](https://docs.liquidramp.com/getting-started/checklist.md): Production readiness for partner integrations.
- [Core Concepts](https://docs.liquidramp.com/introduction/core-concepts.md): Map of Liquidramp business concepts — orders, quotes, settlement, and operational primitives.
- [Exchange Rates](https://docs.liquidramp.com/concepts/exchange-rates.md): How rate preview and reserved quotes relate to order creation.
- [Quotes](https://docs.liquidramp.com/concepts/quotes.md): How rate preview and reserved quotes work before order creation.
- [Orders](https://docs.liquidramp.com/concepts/orders.md): Unified order resource for onramp, offramp, and swap — creation, response shape, and status.
- [Order Lifecycle](https://docs.liquidramp.com/concepts/order-lifecycle.md): How partner-visible order status moves from created through completed.
- [Transaction Statuses](https://docs.liquidramp.com/concepts/transaction-statuses.md): Partner-visible order status values — in-flight vs terminal.
- [Settlement](https://docs.liquidramp.com/concepts/settlement.md): How fiat and crypto legs complete after pay-in, and how that appears on the order.
- [Escrow](https://docs.liquidramp.com/concepts/escrow.md): On-chain protection for crypto during offramp and swap.
- [Callbacks](https://docs.liquidramp.com/concepts/callbacks.md): Outbound webhooks for order lifecycle events.
- [Idempotency](https://docs.liquidramp.com/concepts/idempotency.md): Safe retries on order creation using merchant_reference.
- [Retries](https://docs.liquidramp.com/concepts/retries.md): When to retry API calls and how webhook delivery retries work.
- [Rate Limits](https://docs.liquidramp.com/concepts/rate-limits.md): How to handle 429 responses.
- [Security](https://docs.liquidramp.com/compliance/overview.md): API keys, signing, webhooks, validation, and customer data for partner integrations.
- [Error Handling](https://docs.liquidramp.com/guides/error-handling.md): Response envelopes, error codes, and how to handle failures.
- [Listing Orders](https://docs.liquidramp.com/guides/listing-orders.md): Pagination, filters, and sort order for GET /v1/orders.
- [Webhook Verification](https://docs.liquidramp.com/guides/webhook-verification.md): Step-by-step HMAC verification for inbound Liquidramp webhook deliveries.
- [Onramp Quickstart](https://docs.liquidramp.com/quickstarts/onramp.md): Fiat to crypto — quote, create order, collect pay-in, and settle.
- [Offramp Quickstart](https://docs.liquidramp.com/quickstarts/offramp.md): Crypto to fiat — quote, create order, crypto deposit, and bank payout.
- [Swap Quickstart](https://docs.liquidramp.com/quickstarts/swap.md): Crypto-to-crypto on the same network — quote, deposit, and payout.
- [Webhooks Quickstart](https://docs.liquidramp.com/quickstarts/webhooks.md): Receive order lifecycle events and verify HMAC signatures.
- [Liquidity Providers](https://docs.liquidramp.com/concepts/liquidity-providers.md): How independent providers supply inventory for routed onramp, offramp, and swap orders.
- [Provision Node Setup](https://docs.liquidramp.com/liquidity-providers/node-setup.md): Deploy the Liquidramp provision node on DigitalOcean or AWS and register its URL in the portal.
- [Supported Assets](https://docs.liquidramp.com/resources/supported-assets.md): Crypto currencies available for onramp, offramp, and swap — retrieved via GET /v1/crypto-currencies.
- [Supported Networks](https://docs.liquidramp.com/resources/supported-networks.md): Blockchain networks exposed by GET /v1/networks.
- [Supported Currencies](https://docs.liquidramp.com/resources/supported-currencies.md): Fiat currencies for onramp and offramp — retrieved via GET /v1/fiat-currencies.
- [FAQ](https://docs.liquidramp.com/resources/faq.md): Common integration questions — signatures, KYB, quote expiry, and environments.
- [Error Codes](https://docs.liquidramp.com/resources/errors.md): HTTP status mapping and E_* error codes.
- [Glossary](https://docs.liquidramp.com/resources/glossary.md): Definitions of Liquidramp terms used in the partner API.
- [Changelog](https://docs.liquidramp.com/resources/changelog.md): API and documentation changes, newest first.
- [Health check](https://docs.liquidramp.com/api-reference/health/health-check.md): Returns service status. No authentication required.
- [List institutions](https://docs.liquidramp.com/api-reference/reference/list-institutions.md): Returns banks and mobile-money institutions for fiat payouts and account lookup.
- [List networks](https://docs.liquidramp.com/api-reference/reference/list-networks.md): Returns blockchain networks available for orders.
- [Get network](https://docs.liquidramp.com/api-reference/reference/get-network.md)
- [List network crypto currencies](https://docs.liquidramp.com/api-reference/reference/list-network-crypto-currencies.md)
- [List crypto currencies](https://docs.liquidramp.com/api-reference/reference/list-crypto-currencies.md)
- [Get crypto currency](https://docs.liquidramp.com/api-reference/reference/get-crypto-currency.md)
- [List crypto currency networks](https://docs.liquidramp.com/api-reference/reference/list-crypto-currency-networks.md)
- [List fiat currencies](https://docs.liquidramp.com/api-reference/reference/list-fiat-currencies.md)
- [Resolve bank account name](https://docs.liquidramp.com/api-reference/reference/resolve-bank-account-name.md): Validates `account_number` + `bank_code` (institution `code` from `/institutions`) and returns the account holder name.
- [Get market rate](https://docs.liquidramp.com/api-reference/exchange-rates/get-market-rate.md): Aggregated market buy/sell rate for a pair. Pair format: `NGN_USDT` (fiat_crypto).
- [Preview exchange rate](https://docs.liquidramp.com/api-reference/exchange-rates/preview-exchange-rate.md): Non-reserved rate preview. Pass `from`/`to` legs as query parameters.
- [Create quote](https://docs.liquidramp.com/api-reference/orders/create-quote.md): Reserves a quote. Order type is inferred from the `from`/`to` legs:
- [List orders](https://docs.liquidramp.com/api-reference/orders/list-orders.md): Paginated order list for the authenticated partner.
- [Create order](https://docs.liquidramp.com/api-reference/orders/create-order.md): Unified order creation for onramp, offramp, and swap. Provide `quote_id` from a reserved quote, or `from`/`to` legs directly.
- [Get order](https://docs.liquidramp.com/api-reference/orders/get-order.md): Returns order detail including `payin`, `recipient`, and optional `refund`.
- [Cancel order](https://docs.liquidramp.com/api-reference/orders/cancel-order.md)
- [Submit optional pay-in proof](https://docs.liquidramp.com/api-reference/orders/submit-optional-pay-in-proof.md): Payment is auto-detected. Call this endpoint only if confirmation is delayed.
- [Ordercreated](https://docs.liquidramp.com/api-reference/webhooks/ordercreated.md): Sent when a new order is created. Payload matches the order list shape.

## OpenAPI Specs

- [partner-api](https://docs.liquidramp.com/openapi/partner-api.yaml)
- [openapi](https://docs.liquidramp.com/api-reference/openapi.json)