Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.coinlist.co/llms.txt

Use this file to discover all available pages before exploring further.

The @coinlist-co/react package is the recommended way to integrate CoinList in React and Next.js apps with a backend. It gives you OAuth with PKCE on the client, token exchange and sessions on the server, and ready-made UI for common flows. For a linear walkthrough, start with SDK quickstart.

​
Requirements

  • React 18+ and React DOM 18+ (peer dependencies)
  • A backend you control to store client_secret, exchange authorization codes, and keep refresh tokens out of the browser

​
Install

npm install @coinlist-co/react

pnpm add @coinlist-co/react

yarn add @coinlist-co/react
NPM

​
Entry points

Import paths follow the published exports field:
PathUse for
@coinlist-co/reactCoinListProvider, useCoinList, createCoinListClient, useCompleteCoinListOAuth, config types
@coinlist-co/react/client/componentsBatteries-included UI (CoinListSignInCard, OffersGrid, OfferCard, styles side effect)
@coinlist-co/react/client/hooksHooks only (useCoinListOffers, useCoinListOfferDetails, …)
@coinlist-co/react/client/coreCoinListClient / createCoinListClient for non-React or advanced wiring
@coinlist-co/react/servercreateCoinListServer, session helpers for route handlers (Next.js, etc.)
Prefer client/components for UI, then client/hooks, then client/core and server — see SDK quickstart.

​
Next steps

SDK quickstart

Credentials, install, and architecture in one place.

OAuth recipe

End-to-end sign-in with backend session.