> For the complete documentation index, see [llms.txt](https://docs.forepaas.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.forepaas.org/resources/openapi-specification.md).

# OpenAPI Specification

This page contains the complete HTTP contract. For the public market WebSocket and its client and server messages, see the [AsyncAPI Specification](/resources/asyncapi-specification.md); OpenAPI does not model bidirectional WebSocket message flows.

## User

{% openapi src="/files/5MOm3p5RkCwChISqy4Ij" path="/user/register" method="post" %}
[openapi.yaml](https://3978567741-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlpNKReYzAUPT4VYMRTyV%2Fuploads%2Fgit-blob-df203d883ae750a5f7d589901c91e8064f358f8d%2Fopenapi.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/5MOm3p5RkCwChISqy4Ij" path="/user/profile" method="get" %}
[openapi.yaml](https://3978567741-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlpNKReYzAUPT4VYMRTyV%2Fuploads%2Fgit-blob-df203d883ae750a5f7d589901c91e8064f358f8d%2Fopenapi.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/5MOm3p5RkCwChISqy4Ij" path="/user/{id}" method="get" %}
[openapi.yaml](https://3978567741-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlpNKReYzAUPT4VYMRTyV%2Fuploads%2Fgit-blob-df203d883ae750a5f7d589901c91e8064f358f8d%2Fopenapi.yaml?alt=media)
{% endopenapi %}

## Deposits and withdrawals

{% openapi src="/files/5MOm3p5RkCwChISqy4Ij" path="/deposit/address" method="get" %}
[openapi.yaml](https://3978567741-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlpNKReYzAUPT4VYMRTyV%2Fuploads%2Fgit-blob-df203d883ae750a5f7d589901c91e8064f358f8d%2Fopenapi.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/5MOm3p5RkCwChISqy4Ij" path="/deposit/history" method="get" %}
[openapi.yaml](https://3978567741-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlpNKReYzAUPT4VYMRTyV%2Fuploads%2Fgit-blob-df203d883ae750a5f7d589901c91e8064f358f8d%2Fopenapi.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/5MOm3p5RkCwChISqy4Ij" path="/deposit/status/{tx\_hash}" method="get" %}
[openapi.yaml](https://3978567741-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlpNKReYzAUPT4VYMRTyV%2Fuploads%2Fgit-blob-df203d883ae750a5f7d589901c91e8064f358f8d%2Fopenapi.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/5MOm3p5RkCwChISqy4Ij" path="/withdraw/request" method="post" %}
[openapi.yaml](https://3978567741-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlpNKReYzAUPT4VYMRTyV%2Fuploads%2Fgit-blob-df203d883ae750a5f7d589901c91e8064f358f8d%2Fopenapi.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/5MOm3p5RkCwChISqy4Ij" path="/withdraw/history" method="get" %}
[openapi.yaml](https://3978567741-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlpNKReYzAUPT4VYMRTyV%2Fuploads%2Fgit-blob-df203d883ae750a5f7d589901c91e8064f358f8d%2Fopenapi.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/5MOm3p5RkCwChISqy4Ij" path="/withdraw/limit" method="get" %}
[openapi.yaml](https://3978567741-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlpNKReYzAUPT4VYMRTyV%2Fuploads%2Fgit-blob-df203d883ae750a5f7d589901c91e8064f358f8d%2Fopenapi.yaml?alt=media)
{% endopenapi %}

## Account

{% openapi src="/files/5MOm3p5RkCwChISqy4Ij" path="/account/assets" method="get" %}
[openapi.yaml](https://3978567741-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlpNKReYzAUPT4VYMRTyV%2Fuploads%2Fgit-blob-df203d883ae750a5f7d589901c91e8064f358f8d%2Fopenapi.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/5MOm3p5RkCwChISqy4Ij" path="/account/positions" method="get" %}
[openapi.yaml](https://3978567741-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlpNKReYzAUPT4VYMRTyV%2Fuploads%2Fgit-blob-df203d883ae750a5f7d589901c91e8064f358f8d%2Fopenapi.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/5MOm3p5RkCwChISqy4Ij" path="/account/history" method="get" %}
[openapi.yaml](https://3978567741-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlpNKReYzAUPT4VYMRTyV%2Fuploads%2Fgit-blob-df203d883ae750a5f7d589901c91e8064f358f8d%2Fopenapi.yaml?alt=media)
{% endopenapi %}

## Markets and search

{% openapi src="/files/5MOm3p5RkCwChISqy4Ij" path="/markets/list" method="get" %}
[openapi.yaml](https://3978567741-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlpNKReYzAUPT4VYMRTyV%2Fuploads%2Fgit-blob-df203d883ae750a5f7d589901c91e8064f358f8d%2Fopenapi.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/5MOm3p5RkCwChISqy4Ij" path="/markets/{marketId}/detail" method="get" %}
[openapi.yaml](https://3978567741-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlpNKReYzAUPT4VYMRTyV%2Fuploads%2Fgit-blob-df203d883ae750a5f7d589901c91e8064f358f8d%2Fopenapi.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/5MOm3p5RkCwChISqy4Ij" path="/markets/{marketId}/holders" method="get" %}
[openapi.yaml](https://3978567741-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlpNKReYzAUPT4VYMRTyV%2Fuploads%2Fgit-blob-df203d883ae750a5f7d589901c91e8064f358f8d%2Fopenapi.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/5MOm3p5RkCwChISqy4Ij" path="/markets/{marketId}/live-volume" method="get" %}
[openapi.yaml](https://3978567741-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlpNKReYzAUPT4VYMRTyV%2Fuploads%2Fgit-blob-df203d883ae750a5f7d589901c91e8064f358f8d%2Fopenapi.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/5MOm3p5RkCwChISqy4Ij" path="/markets/category-tree" method="get" %}
[openapi.yaml](https://3978567741-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlpNKReYzAUPT4VYMRTyV%2Fuploads%2Fgit-blob-df203d883ae750a5f7d589901c91e8064f358f8d%2Fopenapi.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/5MOm3p5RkCwChISqy4Ij" path="/search" method="get" %}
[openapi.yaml](https://3978567741-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlpNKReYzAUPT4VYMRTyV%2Fuploads%2Fgit-blob-df203d883ae750a5f7d589901c91e8064f358f8d%2Fopenapi.yaml?alt=media)
{% endopenapi %}

## Order book

{% openapi src="/files/5MOm3p5RkCwChISqy4Ij" path="/orderbook/book" method="get" %}
[openapi.yaml](https://3978567741-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlpNKReYzAUPT4VYMRTyV%2Fuploads%2Fgit-blob-df203d883ae750a5f7d589901c91e8064f358f8d%2Fopenapi.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/5MOm3p5RkCwChISqy4Ij" path="/orderbook/price" method="get" %}
[openapi.yaml](https://3978567741-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlpNKReYzAUPT4VYMRTyV%2Fuploads%2Fgit-blob-df203d883ae750a5f7d589901c91e8064f358f8d%2Fopenapi.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/5MOm3p5RkCwChISqy4Ij" path="/orderbook/midpoint" method="get" %}
[openapi.yaml](https://3978567741-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlpNKReYzAUPT4VYMRTyV%2Fuploads%2Fgit-blob-df203d883ae750a5f7d589901c91e8064f358f8d%2Fopenapi.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/5MOm3p5RkCwChISqy4Ij" path="/orderbook/spread" method="get" %}
[openapi.yaml](https://3978567741-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlpNKReYzAUPT4VYMRTyV%2Fuploads%2Fgit-blob-df203d883ae750a5f7d589901c91e8064f358f8d%2Fopenapi.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/5MOm3p5RkCwChISqy4Ij" path="/orderbook/last-trade-price" method="get" %}
[openapi.yaml](https://3978567741-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlpNKReYzAUPT4VYMRTyV%2Fuploads%2Fgit-blob-df203d883ae750a5f7d589901c91e8064f358f8d%2Fopenapi.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/5MOm3p5RkCwChISqy4Ij" path="/orderbook/tick-size" method="get" %}
[openapi.yaml](https://3978567741-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlpNKReYzAUPT4VYMRTyV%2Fuploads%2Fgit-blob-df203d883ae750a5f7d589901c91e8064f358f8d%2Fopenapi.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/5MOm3p5RkCwChISqy4Ij" path="/orderbook/price-history" method="get" %}
[openapi.yaml](https://3978567741-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlpNKReYzAUPT4VYMRTyV%2Fuploads%2Fgit-blob-df203d883ae750a5f7d589901c91e8064f358f8d%2Fopenapi.yaml?alt=media)
{% endopenapi %}

## Public market data

{% openapi src="/files/5MOm3p5RkCwChISqy4Ij" path="/prices-history" method="get" %}
[openapi.yaml](https://3978567741-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlpNKReYzAUPT4VYMRTyV%2Fuploads%2Fgit-blob-df203d883ae750a5f7d589901c91e8064f358f8d%2Fopenapi.yaml?alt=media)
{% endopenapi %}

## Orders

{% openapi src="/files/5MOm3p5RkCwChISqy4Ij" path="/ordering/create-order" method="post" %}
[openapi.yaml](https://3978567741-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlpNKReYzAUPT4VYMRTyV%2Fuploads%2Fgit-blob-df203d883ae750a5f7d589901c91e8064f358f8d%2Fopenapi.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/5MOm3p5RkCwChISqy4Ij" path="/ordering/cancel-order" method="post" %}
[openapi.yaml](https://3978567741-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlpNKReYzAUPT4VYMRTyV%2Fuploads%2Fgit-blob-df203d883ae750a5f7d589901c91e8064f358f8d%2Fopenapi.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/5MOm3p5RkCwChISqy4Ij" path="/ordering/open-orders" method="post" %}
[openapi.yaml](https://3978567741-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlpNKReYzAUPT4VYMRTyV%2Fuploads%2Fgit-blob-df203d883ae750a5f7d589901c91e8064f358f8d%2Fopenapi.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/5MOm3p5RkCwChISqy4Ij" path="/ordering/claim" method="post" %}
[openapi.yaml](https://3978567741-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlpNKReYzAUPT4VYMRTyV%2Fuploads%2Fgit-blob-df203d883ae750a5f7d589901c91e8064f358f8d%2Fopenapi.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/5MOm3p5RkCwChISqy4Ij" path="/ordering/claim\_all" method="post" %}
[openapi.yaml](https://3978567741-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlpNKReYzAUPT4VYMRTyV%2Fuploads%2Fgit-blob-df203d883ae750a5f7d589901c91e8064f358f8d%2Fopenapi.yaml?alt=media)
{% endopenapi %}

## Multi-factor authentication

{% openapi src="/files/5MOm3p5RkCwChISqy4Ij" path="/user/mfa/setup/totp/init" method="post" %}
[openapi.yaml](https://3978567741-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlpNKReYzAUPT4VYMRTyV%2Fuploads%2Fgit-blob-df203d883ae750a5f7d589901c91e8064f358f8d%2Fopenapi.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/5MOm3p5RkCwChISqy4Ij" path="/user/mfa/setup/totp/complete" method="post" %}
[openapi.yaml](https://3978567741-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlpNKReYzAUPT4VYMRTyV%2Fuploads%2Fgit-blob-df203d883ae750a5f7d589901c91e8064f358f8d%2Fopenapi.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/5MOm3p5RkCwChISqy4Ij" path="/user/mfa/methods/totp/remove" method="post" %}
[openapi.yaml](https://3978567741-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlpNKReYzAUPT4VYMRTyV%2Fuploads%2Fgit-blob-df203d883ae750a5f7d589901c91e8064f358f8d%2Fopenapi.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/5MOm3p5RkCwChISqy4Ij" path="/user/mfa/verification/send-email-otp" method="post" %}
[openapi.yaml](https://3978567741-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlpNKReYzAUPT4VYMRTyV%2Fuploads%2Fgit-blob-df203d883ae750a5f7d589901c91e8064f358f8d%2Fopenapi.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/5MOm3p5RkCwChISqy4Ij" path="/user/mfa/verification/verify" method="post" %}
[openapi.yaml](https://3978567741-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlpNKReYzAUPT4VYMRTyV%2Fuploads%2Fgit-blob-df203d883ae750a5f7d589901c91e8064f358f8d%2Fopenapi.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/5MOm3p5RkCwChISqy4Ij" path="/user/mfa/methods/email/remove" method="post" %}
[openapi.yaml](https://3978567741-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlpNKReYzAUPT4VYMRTyV%2Fuploads%2Fgit-blob-df203d883ae750a5f7d589901c91e8064f358f8d%2Fopenapi.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/5MOm3p5RkCwChISqy4Ij" path="/user/mfa/status" method="get" %}
[openapi.yaml](https://3978567741-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlpNKReYzAUPT4VYMRTyV%2Fuploads%2Fgit-blob-df203d883ae750a5f7d589901c91e8064f358f8d%2Fopenapi.yaml?alt=media)
{% endopenapi %}

## Trades

{% openapi src="/files/5MOm3p5RkCwChISqy4Ij" path="/trades" method="get" %}
[openapi.yaml](https://3978567741-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlpNKReYzAUPT4VYMRTyV%2Fuploads%2Fgit-blob-df203d883ae750a5f7d589901c91e8064f358f8d%2Fopenapi.yaml?alt=media)
{% endopenapi %}