> For the complete documentation index, see [llms.txt](https://docs.unisat.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.unisat.io/developer-support/open-api-documentation/api-for-fractal-bitcoin/unisat-marketplace-on-fractal/brc20-marketplace.md).

# BRC20 Marketplace

{% openapi src="/files/aIRMkbOHCqWLAooSGDx6" path="/v3/market/brc20/auction/brc20\_kline" method="post" %}
[swagger.yaml](https://3523236551-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FJ4NHAHIVnWQiEecvs1By%2Fuploads%2FAb1MQjWXpVkDe4owSJwn%2Fswagger.yaml?alt=media\&token=00abbd0c-0a47-4bbf-9509-f8acae430446)
{% endopenapi %}

**Parameter Description**

* `tick`: BRC-20 tick
* `timeStart`: The starting timestamp, measured in milliseconds.
* `timeEnd`: The ending timestamp, measured in milliseconds.
* `timeStep`: Represents the interval between each data point, measured in milliseconds.

Additionally, there are the following limitations on the requested parameters.

`(timeEnd-timeStart)/timeStep <= 2016`

{% openapi src="/files/aIRMkbOHCqWLAooSGDx6" path="/v3/market/brc20/auction/brc20\_types" method="post" %}
[swagger.yaml](https://3523236551-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FJ4NHAHIVnWQiEecvs1By%2Fuploads%2FAb1MQjWXpVkDe4owSJwn%2Fswagger.yaml?alt=media\&token=00abbd0c-0a47-4bbf-9509-f8acae430446)
{% endopenapi %}

The optional values for `timeType` are `day1`, `day7`, `day30`.

`ticks` can be used to filter the "list," allowing it to return only the ticks that are needed.If the `ticks` field is not provided, all BRC20 data will be returned.

In the returned fields of this interface, only the "list" field needs attention. The "deploy" and "cap" fields are included solely for display purposes on certain pages of UniSat Marketplace. Filtering the fields will not affect "deploy" and "cap"; they will always be returned.

<figure><img src="https://3523236551-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FJ4NHAHIVnWQiEecvs1By%2Fuploads%2FeDEhGop5j6UC1ubiFHUB%2Fimage.png?alt=media&amp;token=c3e9f0e0-8ff9-4880-9796-ba59faf4e1ae" alt=""><figcaption><p>Use start and limit</p></figcaption></figure>

<figure><img src="https://3523236551-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FJ4NHAHIVnWQiEecvs1By%2Fuploads%2FTwlLvFKAjZ3AGLqDFfgW%2Fimage.png?alt=media&amp;token=0f3b8f40-33a2-44d3-b9c5-cb8b4cbc9a38" alt=""><figcaption><p>Use ticks</p></figcaption></figure>

{% openapi src="/files/aIRMkbOHCqWLAooSGDx6" path="/v3/market/brc20/auction/brc20\_types\_specified" method="post" %}
[swagger.yaml](https://3523236551-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FJ4NHAHIVnWQiEecvs1By%2Fuploads%2FAb1MQjWXpVkDe4owSJwn%2Fswagger.yaml?alt=media\&token=00abbd0c-0a47-4bbf-9509-f8acae430446)
{% endopenapi %}

The optional values for `timeType` are `day1`, `day7`, `day30`

{% openapi src="/files/aIRMkbOHCqWLAooSGDx6" path="/v3/market/brc20/auction/bind" method="post" %}
[swagger.yaml](https://3523236551-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FJ4NHAHIVnWQiEecvs1By%2Fuploads%2FAb1MQjWXpVkDe4owSJwn%2Fswagger.yaml?alt=media\&token=00abbd0c-0a47-4bbf-9509-f8acae430446)
{% endopenapi %}

By default, a user's address A is used for both payment and receiving inscriptions. However, for some wallets, such as the xverse and hiro wallets, different addresses are used to store BTC and inscriptions. This method allows the wallet to use address A for payments and address B for receiving inscriptions.

```typescript
import {signMessage} from "sats-connect"

const paymentAddress = "";
const ordinalsAddress = "";

const toSignStr = `Please confirm that\nPayment Address: ${paymentAddress}\nOrdinals Address: ${ordinalsAddress}`

// for xverse
signMessage({
    payload:{
        address: ordinalsAddress,
        message: toSignStr,
        network:{
            type: "Mainnet"
        }
    },
    onFinish:(signature)=>{
        axios.post('/v3/market/brc20/auction/bind', {
            btcAddress: paymentAddress,
            nftAddress: ordinalsAddress,
            sign:signature
        })

    }
}
```

{% openapi src="/files/aIRMkbOHCqWLAooSGDx6" path="/v3/market/brc20/auction/list" method="post" %}
[swagger.yaml](https://3523236551-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FJ4NHAHIVnWQiEecvs1By%2Fuploads%2FAb1MQjWXpVkDe4owSJwn%2Fswagger.yaml?alt=media\&token=00abbd0c-0a47-4bbf-9509-f8acae430446)
{% endopenapi %}

{% openapi src="/files/aIRMkbOHCqWLAooSGDx6" path="/v3/market/brc20/auction/inscription\_info" method="post" %}
[swagger.yaml](https://3523236551-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FJ4NHAHIVnWQiEecvs1By%2Fuploads%2FAb1MQjWXpVkDe4owSJwn%2Fswagger.yaml?alt=media\&token=00abbd0c-0a47-4bbf-9509-f8acae430446)
{% endopenapi %}

<figure><img src="https://3523236551-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FJ4NHAHIVnWQiEecvs1By%2Fuploads%2FT6QESFrUfnHDDyC6nKG3%2Fimage.png?alt=media&amp;token=80f53cd3-4d46-44d1-87b3-260e9876bd53" alt=""><figcaption></figcaption></figure>

{% openapi src="/files/aIRMkbOHCqWLAooSGDx6" path="/v3/market/brc20/auction/inscription\_info\_list" method="post" %}
[swagger.yaml](https://3523236551-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FJ4NHAHIVnWQiEecvs1By%2Fuploads%2FAb1MQjWXpVkDe4owSJwn%2Fswagger.yaml?alt=media\&token=00abbd0c-0a47-4bbf-9509-f8acae430446)
{% endopenapi %}

{% openapi src="/files/aIRMkbOHCqWLAooSGDx6" path="/v3/market/brc20/auction/create\_put\_on" method="post" %}
[swagger.yaml](https://3523236551-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FJ4NHAHIVnWQiEecvs1By%2Fuploads%2FAb1MQjWXpVkDe4owSJwn%2Fswagger.yaml?alt=media\&token=00abbd0c-0a47-4bbf-9509-f8acae430446)
{% endopenapi %}

<figure><img src="https://3523236551-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FJ4NHAHIVnWQiEecvs1By%2Fuploads%2FSlJxxYcFwufP5FDmUbKu%2Fimage.png?alt=media&amp;token=448ce326-bb10-471c-824c-cb63733c096f" alt=""><figcaption></figcaption></figure>

* btcAddress:  (Optional) Only for multi-address wallet, such as Xverse, hiro. To specifies the BTC receive address

{% openapi src="/files/aIRMkbOHCqWLAooSGDx6" path="/v3/market/brc20/auction/confirm\_put\_on" method="post" %}
[swagger.yaml](https://3523236551-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FJ4NHAHIVnWQiEecvs1By%2Fuploads%2FAb1MQjWXpVkDe4owSJwn%2Fswagger.yaml?alt=media\&token=00abbd0c-0a47-4bbf-9509-f8acae430446)
{% endopenapi %}

{% openapi src="/files/aIRMkbOHCqWLAooSGDx6" path="/v3/market/brc20/auction/create\_bid\_prepare" method="post" %}
[swagger.yaml](https://3523236551-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FJ4NHAHIVnWQiEecvs1By%2Fuploads%2FAb1MQjWXpVkDe4owSJwn%2Fswagger.yaml?alt=media\&token=00abbd0c-0a47-4bbf-9509-f8acae430446)
{% endopenapi %}

* serverFee: Service Fee
* serverReal: The service fee after deducting various discounts.
* serverFeeRate:  Service fee rate
* txSzie: The virtual size of this transaction.
* nftValue: Satoshis in the inscription
* feeRate: The current accepted minimum network fee rate.
* availableBalance：BTC balance available for constructing transactions."

{% openapi src="/files/aIRMkbOHCqWLAooSGDx6" path="/v3/market/brc20/auction/create\_bid" method="post" %}
[swagger.yaml](https://3523236551-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FJ4NHAHIVnWQiEecvs1By%2Fuploads%2FAb1MQjWXpVkDe4owSJwn%2Fswagger.yaml?alt=media\&token=00abbd0c-0a47-4bbf-9509-f8acae430446)
{% endopenapi %}

{% openapi src="/files/aIRMkbOHCqWLAooSGDx6" path="/v3/market/brc20/auction/create\_modify\_price" method="post" %}
[swagger.yaml](https://3523236551-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FJ4NHAHIVnWQiEecvs1By%2Fuploads%2FAb1MQjWXpVkDe4owSJwn%2Fswagger.yaml?alt=media\&token=00abbd0c-0a47-4bbf-9509-f8acae430446)
{% endopenapi %}

{% openapi src="/files/aIRMkbOHCqWLAooSGDx6" path="/v3/market/brc20/auction/confirm\_modify\_price" method="post" %}
[swagger.yaml](https://3523236551-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FJ4NHAHIVnWQiEecvs1By%2Fuploads%2FAb1MQjWXpVkDe4owSJwn%2Fswagger.yaml?alt=media\&token=00abbd0c-0a47-4bbf-9509-f8acae430446)
{% endopenapi %}
