{"mock":"https://private-anon-4f78d1fd48-woortonotcv1.apiary-mock.com/","production":"https://api-sandbox.woorton.com/","proxy":"https://private-anon-4f78d1fd48-woortonotcv1.apiary-proxy.com/"}
swagger: '2.0'
info:
version: '1.0'
title: "Woorton Market-Maker OTC API"
description: |
The Woorton OTC Public API allows clients to access the market-maker service anytime.
<br>
The main usage is get quotations and executing trades.
<br><br>
**Clients must be registered to Woorton OTC service to use this API.**
<br>
Sandbox Environment URL: https://api-sandbox.woorton.com
<br>
<hr>
<h5>Authentication</h5>
To authenticate with the API, you must add an <code>Authorization</code> header,
with the following format : <code>Bearer <TOKEN></code>.
<br><br>
Example:
<br>
<code>Authorization: Bearer e3f515ac6b9b81cd48de42d2ce3f0ada</code>
<br><br>
Your token will be securely send it to you by Woorton support team.
<hr>
<h5>Security</h5>
API access is filtered with IP whitelisting, please contact Woorton support team
to whitelist your IPs.
<hr>
<h5>General notes</h5>
<ul>
<li>obviously, API is only accessible through TLS ;
<li>dates are in <a href="https://fr.wikipedia.org/wiki/ISO_8601#UTC">ISO 8601 UTC format</a>.</li>
</ul>
<hr>
<h5>Libraries and implementation examples</h5>
You can find API client library for different languages:
<ul>
<li><a href="https://github.com/jwoorton/woorton-API-python">Python</a> ;</li>
<li><i>more coming soon... </i></li>
</ul>
host: api-sandbox.woorton.com
basePath: /api/v1
schemes:
- https
consumes:
- application/json
produces:
- application/json
paths:
/request_quotes:
x-summary: Request for Quote
post:
description: |
You may request for a quotation using this action.
<br>
Once the quotation is returned (in response), you will have a short delay to confirm,
ie execute, the trade, by calling the `/api/v1/trade` API.
<br>
Quote expires approximately 20 seconds after the request.
<br>
Allowed instrument can queried via <code>/api/v1/instruments</code>.
<br>
<table>
<thead>
<tr>
<th>Pair</th>
<th>Amount precision</th>
<th>Total precision</th>
</tr>
</thead>
<tbody>
<tr>
<td>ETHBTC.SPOT</td>
<td>2</td>
<td>8</td>
</tr>
<tr>
<td>ETHUST.SPOT</td>
<td>2</td>
<td>2</td>
</tr>
<tr>
<td>BTCUST.SPOT</td>
<td>2</td>
<td>2</td>
</tr>
<tr>
<td>LTCUST.SPOT</td>
<td>2</td>
<td>2</td>
</tr>
<tr>
<td>BCHUST.SPOT</td>
<td>2</td>
<td>2</td>
</tr>
<tr>
<td>XRPUST.SPOT</td>
<td>2</td>
<td>2</td>
</tr>
<tr>
<td><i>Others</i></td>
<td>4</td>
<td>2</td>
</tr>
</tbody>
</table>
summary: Create a New RFQ
parameters:
- name: body
in: body
required: true
schema:
$ref: '#/definitions/RFQ_request'
responses:
201:
description: 'Successful response'
schema:
$ref: '#/definitions/RFQ_response'
examples:
application/json:
client_request_id: "d83b5b1a-4d2c-4582-955c-d01abbad9e01"
request_id: "3cdb0e86-5001-4b0c-bd35-0b51b3062575"
amount: "1.00000000"
price: "1745.51"
total: "1745.51"
instrument: "BTCEUR.SPOT"
direction: "buy"
created_at: "2018-12-29T14:33:24.001345Z"
expires_at: "2018-12-29T14:33:39.001345Z"
/trades:
x-summary: Trades
post:
description: |
Confirm the given quotation by executing a trade.
<br>
Quotation can only be confirmed, not changed.
<br>
Note: all parameters of the corresponding RFQ must be given again.
summary: Confirm a quote (ie execute trade)
parameters:
- name: body
in: body
required: true
schema:
$ref: '#/definitions/Trade_request'
responses:
201:
description: 'Successful response'
schema:
$ref: '#/definitions/Trade_response'
examples:
application/json:
client_request_id: "d83b5b1a-4d2c-4582-955c-d01abbad9e01"
amount: "1.00000000"
price: "3123.12345678"
total: "3123.12345678"
direction: "buy"
instrument: "BTCEUR.SPOT"
state: "executed"
created_at: "2018-12-29T14:33:24.001345Z"
expired_date: "2018-12-29T14:33:39.001345Z"
get:
summary: List Trades
description: |
You may list all trades using this action.
<br>
Results can be filtered per state (allowed states are `executed`, `canceled` and `pending_confirmation`).
<br>
Results are paginated (see `page` & `per_page` parameter). At most 100 items are returned per query.
parameters:
- name: page
in: query
type: number
x-example: 1
- name: per_page
in: query
type: number
x-example: 50
- name: state
in: query
type: string
x-example: executed
responses:
200:
description: Successful Response
schema:
type: array
items:
- $ref: '#/definitions/Trade_response'
examples:
application/json:
- request_id: "b1dec8dd-d33f-46d9-a6a6-e10cc721264a"
client_request_id: "d83b5b1a-4d2c-4582-955c-d01abbad9e01"
amount: 1.23112200
price: 14545.33445544
instrument: "BTCEUR.SPOT"
direction: "buy"
state: "executed"
- request_id: "14a357bd-f45a-449c-854a-89af2600c26c"
client_request_id: "693c39b3-90ff-4d27-9265-c42b6ce93369"
amount: 0.10000000
price: 345.34166560
instrument: "BTCEUR.SPOT"
direction: "buy"
state: "canceled"
/balances:
x-summary: Balances
get:
summary: Get balances for all currencies.
description: |
You may list all your balances using this action.
<br>
The sign of the amount indicates who owes to the other:
<ul>
<li>negative: you owe Woorton the amount ;
<li>positive: Woorton owe you the amount.
</ul>
responses:
200:
description: Successful Response
schema:
type: array
items:
- $ref: '#/definitions/Balances'
examples:
application/json:
USD: 0.0
EUR: 0.0
ETH: 0.0
BTC: 0.0
LTC: 0.0
/exposures:
x-summary: Exposures
get:
summary: Get exposure for all currencies
description: |
You may list your allowed and consumed exposure for all currencies using this action.
<br>
For each currency, you get your maximum exposure amount.
<br><br>
<b>Note</b>:
<ul>
<li>pending settlement request are not take in account until confirmed by Woorton team ;</li>
<li>you can contact Woorton support to increase your exposures.</li>
</ul>
responses:
200:
description: Successful Response
schema:
type: array
items:
- $ref: '#/definitions/Exposures'
examples:
application/json:
USD: 50000.0
EUR: 50000.0
ETH: 100.0
BTC: 10.0
LTC: 100.0
/ledger:
x-summary: Ledger
get:
summary: List ledger operations.
description: |
You may list all ledger operations using this action.
<br>
Operation's category can be:
<ul>
<li><code>trade</code>;</li>
<li><code>withdrawal</code>;</li>
<li><code>deposit</code>.</li>
</ul>
<br>
Results are paginated (see <code>page</code> & <code>per_page</code> parameter). At most 100 items are returned per query.
parameters:
- name: page
in: query
type: number
x-example: 1
- name: per_page
in: query
type: number
x-example: 50
responses:
200:
description: Successful Response
schema:
type: array
items:
- $ref: '#/definitions/Ledger'
examples:
application/json:
- operation_id: "0ea203d1-a2de-4f85-ad9e-689e422d8fae"
currency: "BTC"
amount: "13.43554455"
category: "trade"
created_at: "2018-12-24T19:15:31.012345Z"
- operation_id: "1f6cf143-bbe5-46d5-825e-e21814d55bc9"
currency: "EUR"
amount: "40000.00000000"
category: "deposit"
created_at: "2018-12-25T13:55:34.012345Z"
/instruments:
x-summary: Instruments
get:
summary: List available instruments.
description: |
You may list all instruments using this action.
<br>
Instruments' list could change over time, please consult this list regularly.
parameters:
- name: page
in: query
type: number
x-example: 1
responses:
200:
description: Successful Response
schema:
type: array
items:
- $ref: '#/definitions/Instruments'
definitions:
RFQ_request:
title: Request for Quote Request
type: object
properties:
client_request_id:
type: string
default: "d83b5b1a-4d2c-4582-955c-d01abbad9e01"
amount:
type: number
default: "1.0"
instrument:
type: string
example: "BTCEUR.SPOT"
direction:
type: string
example: "buy"
required:
- client_request_id
- amount
- instrument
- direction
RFQ_response:
title: Request for Quote Response
type: object
properties:
client_request_id:
type: string
default: "some-client-uuid"
request_id:
type: string
default: "some-uuid"
instrument:
type: string
example: "BTCEUR.SPOT"
direction:
type: string
example: "buy"
amount:
type: number
default: "1.0"
total:
type: number
example: "3123.12"
price:
type: number
example: "3123.12"
created_at:
type: string
example: "2018-12-23T21:51:34.001122Z"
expires_at:
type: string
example: "2018-12-23T21:51:34.001122Z"
Trade_request:
title: Trade
type: object
properties:
request_id:
type: string
default: "some-uuid"
amount:
type: number
default: "1.0"
total:
type: number
default: "3123.12345678"
instrument:
type: string
example: "BTCEUR.SPOT"
direction:
type: string
example: "buy"
Trade_response:
title: Trade
type: object
properties:
request_id:
type: string
client_request_id:
type: string
total:
type: number
example: "3123.12345678"
amount:
type: number
default: "1.0"
instrument:
type: string
example: "BTCEUR.SPOT"
direction:
type: string
example: "buy"
state:
type: string
enum: ["executed", "canceled", "pending_quote"]
example: "executed"
created_at:
type: string
example: "2018-12-23T21:51:25.001122Z"
executed_at:
type: string
example: "2018-12-23T21:51:34.001122Z"
Balances:
title: Balances
type: object
properties:
USD:
type: number
example: 0.0
EUR:
type: number
example: 0.0
BTC:
type: number
example: 0.0
LTC:
type: number
example: 0.0
XRP:
type: number
example: 0.0
BCH:
type: number
example: 0.0
Exposures:
title: Exposures
type: object
properties:
USD:
type: number
example: 0.0
EUR:
type: number
example: 0.0
BTC:
type: number
example: 0.0
LTC:
type: number
example: 0.0
XRP:
type: number
example: 0.0
BCH:
type: number
example: 0.0
Instruments:
title: Instruments
type: array
example:
instrumennts:
- "ETHBTC.SPOT"
- "ETHUSD.SPOT"
- "ETHEUR.SPOT"
- "BTCEUR.SPOT"
- "BTCUSD.SPOT"
- "LTCUSD.SPOT"
- "LTCEUR.SPOT"
- "BCHUSD.SPOT"
Ledger:
title: Ledger
type: array
items:
type: object
LedgerEntry:
title: Ledger entry
type: object
properties:
operation_id:
type: string
example: "2647ad2d-aca4-435b-b2b7-a466f0677c2a"
currency:
type: string
amount:
type: number
category:
type: string
created_at:
type: string
enum: ["trade", "deposit", "withdrawal"]
