# API Specification

Our API is defined using the OpenAPI 3.0 specification. You can easily explore and test the endpoints using tools like Swagger UI, or Postman. For convenience, you can interact with our API on our hosted SwaggerUI page:\
<https://app.runesdex.com/v1/swagger>

You can also quickly send sample API requests using the [API Explorer](#api-explorer) below. If you'd prefer to use a tool like Postman, download our OpenAPI spec available at:\
<https://app.runesdex.com/v1/swagger/swagger.yaml>

## API Explorer

{% openapi src="<https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml>" path="/v1/healthcheck" method="get" %}
[swagger.yaml](https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml)
{% endopenapi %}

{% openapi src="<https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml>" path="/v1/version" method="get" %}
[swagger.yaml](https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml)
{% endopenapi %}

{% openapi src="<https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml>" path="/v1/runes" method="get" %}
[swagger.yaml](https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml)
{% endopenapi %}

{% openapi src="<https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml>" path="/v1/status" method="get" %}
[swagger.yaml](https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml)
{% endopenapi %}

{% openapi src="<https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml>" path="/v1/runes/search" method="get" %}
[swagger.yaml](https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml)
{% endopenapi %}

{% openapi src="<https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml>" path="/v1/runes/{rune}" method="get" %}
[swagger.yaml](https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml)
{% endopenapi %}

{% openapi src="<https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml>" path="/v1/runes/by-address/{address}/balance/{rune}" method="get" %}
[swagger.yaml](https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml)
{% endopenapi %}

{% openapi src="<https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml>" path="/v1/runes/by-address/{address}/balance" method="get" %}
[swagger.yaml](https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml)
{% endopenapi %}

{% openapi src="<https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml>" path="/v1/utxo/{asset}/{address}" method="get" %}
[swagger.yaml](https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml)
{% endopenapi %}

{% openapi src="<https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml>" path="/v1/btc/balance/{address}" method="get" %}
[swagger.yaml](https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml)
{% endopenapi %}

{% openapi src="<https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml>" path="/v1/pairs" method="get" %}
[swagger.yaml](https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml)
{% endopenapi %}

{% openapi src="<https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml>" path="/v1/pairs/create" method="post" %}
[swagger.yaml](https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml)
{% endopenapi %}

{% openapi src="<https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml>" path="/v1/pairs/{base}-{quote}" method="get" %}
[swagger.yaml](https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml)
{% endopenapi %}

{% openapi src="<https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml>" path="/v1/pairs/{base}-{quote}/address-position/{address}" method="get" %}
[swagger.yaml](https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml)
{% endopenapi %}

{% openapi src="<https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml>" path="/v1/pairs/{base}-{quote}/add-liquidity" method="post" %}
[swagger.yaml](https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml)
{% endopenapi %}

{% openapi src="<https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml>" path="/v1/pairs/{base}-{quote}/calculate" method="get" %}
[swagger.yaml](https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml)
{% endopenapi %}

{% openapi src="<https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml>" path="/v1/pairs/{base}-{quote}/swap" method="post" %}
[swagger.yaml](https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml)
{% endopenapi %}

{% openapi src="<https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml>" path="/v1/pairs/{base}-{quote}/remove-liquidity" method="post" %}
[swagger.yaml](https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml)
{% endopenapi %}

{% openapi src="<https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml>" path="/v1/pairs/{base}-{quote}/price-history" method="get" %}
[swagger.yaml](https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml)
{% endopenapi %}

{% openapi src="<https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml>" path="/v1/pairs/{base}-{quote}/swap-history" method="get" %}
[swagger.yaml](https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml)
{% endopenapi %}

{% openapi src="<https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml>" path="/v1/publish-tx" method="post" %}
[swagger.yaml](https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml)
{% endopenapi %}

{% openapi src="<https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml>" path="/v1/users/{address}/liquidity" method="get" %}
[swagger.yaml](https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml)
{% endopenapi %}

{% openapi src="<https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml>" path="/v1/users/{address}" method="get" %}
[swagger.yaml](https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml)
{% endopenapi %}

{% openapi src="<https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml>" path="/v1/users" method="post" %}
[swagger.yaml](https://content.gitbook.com/content/BGh35sxgiN7ABDvGLn7g/blobs/Y8i3kDmXH7CIUah7kKYG/swagger.yaml)
{% endopenapi %}