Skip to content

Commit

Permalink
docs: getSwapQuote
Browse files Browse the repository at this point in the history
  • Loading branch information
Zizzamia committed Jun 13, 2024
1 parent 746d78b commit 788f1de
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions site/docs/pages/swap/get-swap-quote.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# `getSwapQuote`

The `getSwapQuote` function is used to get a quote for a swap between two assets.

## Usage

:::code-group

```tsx [code]
import { getSwapQuote } from '@coinbase/onchainkit/swap';

const quote = await getSwapQuote({ ... });
```

```ts [return value]
...
```

:::

## Returns

[`Promise<GetSwapQuoteResponse>`](/token/types#GetSwapQuoteResponse)

## Parameters

[`GetSwapQuoteParams`](/token/types#GetSwapQuoteParams)

0 comments on commit 788f1de

Please sign in to comment.