Ripio Trade API v4
REST + WebSocket cryptocurrency trading API — market data, orders, balances, statements, deposits, and cryptocurrency withdrawals. API Token + HMAC-SHA256 auth.
OpenAPI Specification
openapi: 3.0.0
components:
examples: {}
headers: {}
parameters: {}
requestBodies: {}
responses: {}
schemas:
Record_string.boolean_:
properties: {}
additionalProperties:
type: boolean
type: object
description: Construct a type with a set of properties K of type T
TickersResponseData:
properties:
pair:
type: string
description: Currency pair code
example: BTC_BRL
price_change_percent_24h:
type: string
description: 24-hr % price change of market pair
high:
type: number
format: float
description: Highest price in the last 24 hours
low:
type: number
format: float
description: Lowest price in the last 24 hours
volume:
type: number
format: float
description: Volume in the last 24 hours
trades_quantity:
type: number
format: int32
description: Trades quantity in the last 24 hours
last:
type: number
format: float
description: Price of the last trade
bid:
type: number
format: float
description: Price of the current best buy order in the orderbook
ask:
type: number
format: float
description: Price of the current best sell order in the orderbook
date:
type: string
description: Timestamp of the last update (UTC)
first:
type: number
format: float
description: Price of the first trade in the last 24 hours window
is_frozen:
type: boolean
description: Whether the market is currently frozen (disabled)
base_code:
type: string
description: Base currency code
base_id:
type: string
description: Base currency ID
quote_id:
type: string
description: Quote currency ID
quote_code:
type: string
description: Quote currency code
quote_volume:
type: number
format: double
description: Quote currency volume
required:
- pair
- price_change_percent_24h
- high
- low
- volume
- trades_quantity
- last
- bid
- ask
- date
- first
- is_frozen
- base_code
- base_id
- quote_id
- quote_code
- quote_volume
type: object
additionalProperties: false
AllTickersResponse:
properties:
data:
items:
$ref: '#/components/schemas/TickersResponseData'
type: array
example:
- ask: 250000.15
base_code: BTC
base_id: 9A5E2EF4-9547-418A-8EC6-C6EADBB8B32F
bid: 240000.15
date: '2017-10-20T00:00:00Z'
first: 245000.15
high: 250000.15
is_frozen: false
last: 245000.15
low: 200000.15
pair: BTC_BRL
price_change_percent_24h: '-12'
quote_code: BRL
quote_id: 48898138-8623-4555-9468-B1A1505A9352
quote_volume: 150.1
trades_quantity: 123
volume: 123.12345678
- ask: 15600.12
base_code: ETH
base_id: 13A4B83B-E74F-425C-BC0A-03A9C0F29FAD
bid: 15400.12
date: '2017-10-20T00:00:00Z'
first: 15999.15
high: 15999.12
is_frozen: false
last: 15500.12
low: 15000.12
pair: ETH_BRL
price_change_percent_24h: '-12'
quote_id: 48898138-8623-4555-9468-B1A1505A9352
quote_code: BRL
quote_volume: 180.1
trades_quantity: 123
volume: 123.12345678
error_code:
type: number
enum:
- null
nullable: true
example: null
message:
type: string
nullable: true
example: null
required:
- data
- error_code
- message
type: object
additionalProperties: false
TickersResponseDataV4:
properties:
high:
type: number
format: float
description: Highest price in the last 24 hours
low:
type: number
format: float
description: Lowest price in the last 24 hours
volume:
type: number
format: float
description: Volume in the last 24 hours
trades_quantity:
type: number
format: int32
description: Number of trades in the last 24 hours
last:
type: number
format: float
description: Price of the most recent trade
bid:
type: number
format: float
description: Best bid price (highest price a buyer is willing to pay)
ask:
type: number
format: float
description: Best ask price (lowest price a seller is willing to accept)
date:
type: string
description: Timestamp of the last update (UTC)
first:
type: number
format: float
description: Price of the first trade in the last 24 hours window
is_frozen:
type: boolean
description: Whether the market is currently frozen (disabled)
base_code:
type: string
description: Base currency code
base_id:
type: string
description: Base currency ID
quote_id:
type: string
description: Quote currency ID
quote_code:
type: string
description: Quote currency code
quote_volume:
type: number
format: double
description: Quote currency volume
price_change_percent_24h:
type: string
description: 24-hr % price change of market pair
required:
- high
- low
- volume
- trades_quantity
- last
- bid
- ask
- date
- first
- is_frozen
- base_code
- base_id
- quote_id
- quote_code
- quote_volume
- price_change_percent_24h
type: object
additionalProperties: false
example:
ask: 95629
base_code: BTC
base_id: 9A5E2EF4-9547-418A-8EC6-C6EADBB8B32F
bid: 94171
date: '2022-11-11T01:31:35.820Z'
first: 98444
high: 98444
is_frozen: false
last: 94311
low: 85034
pair: BTC_BRL
price_change_percent_24h: '-12'
quote_id: 48898138-8623-4555-9468-B1A1505A9352
quote_code: BRL
quote_volume: 150.1
trades_quantity: 1199
volume: 27.26776846
TickersResponseV4:
properties:
data:
$ref: '#/components/schemas/TickersResponseDataV4'
error_code:
type: number
enum:
- null
nullable: true
example: null
message:
type: string
nullable: true
example: null
required:
- data
- error_code
- message
type: object
additionalProperties: false
ActiveOrderLevel3:
properties:
amount:
type: number
format: float
description: Currency amount
id:
type: string
description: Order id
format: string
price:
type: number
format: float
description: Price
required:
- amount
- id
- price
type: object
additionalProperties: false
PublicOrdersLevel3ResponseData:
properties:
timestamp:
type: number
format: double
description: Current timestamp
example: 1675708481219
asks:
items:
$ref: '#/components/schemas/ActiveOrderLevel3'
type: array
description: Sell orders
example:
- amount: 0.01187517
id: 554F2D70-04B9-4E26-9548-9C35B025A018
price: 14704.45
- amount: 1
id: C1C5DA8E-A069-4E20-87D1-12B19426A013
price: 1873.48
bids:
items:
$ref: '#/components/schemas/ActiveOrderLevel3'
type: array
description: Buy orders
example:
- amount: 0.46097295
id: E6D05F51-D79B-47CF-84C5-B157120EBC25
price: 14650.25
- amount: 1
id: CE743407-66BE-4F4C-AD0E-AB376468C5F6
price: 1610.15
hash:
type: string
description: Hash of asks and bids
example: '16757084812196786445'
required:
- timestamp
- asks
- bids
- hash
type: object
additionalProperties: false
PublicOrdersLevel3Response:
properties:
data:
$ref: '#/components/schemas/PublicOrdersLevel3ResponseData'
error_code:
type: number
enum:
- null
nullable: true
example: null
message:
type: string
nullable: true
example: null
required:
- data
- error_code
- message
type: object
additionalProperties: false
LimitParamV4:
type: number
format: int32
default: 100
example: 25
description: Maximum number of records to return per request
maximum: 250
minimum: 1
ActiveOrderLevel2:
properties:
amount:
type: number
format: float
description: Amount
price:
type: number
format: float
description: Price
required:
- amount
- price
type: object
additionalProperties: false
PublicOrdersLevel2ResponseData:
properties:
timestamp:
type: number
format: double
description: Current timestamp
example: 1675708481219
asks:
items:
$ref: '#/components/schemas/ActiveOrderLevel2'
type: array
description: Sell orders
example:
- amount: 0.01187517
price: 14704.45
- amount: 1
price: 1873.48
bids:
items:
$ref: '#/components/schemas/ActiveOrderLevel2'
type: array
description: Buy orders
example:
- amount: 0.46097295
price: 14650.25
- amount: 1
price: 1610.15
hash:
type: string
description: Hash of asks and bids
example: '16757084812196786445'
required:
- timestamp
- asks
- bids
- hash
type: object
additionalProperties: false
PublicOrdersLevel2Response:
properties:
data:
$ref: '#/components/schemas/PublicOrdersLevel2ResponseData'
error_code:
type: number
enum:
- null
nullable: true
example: null
message:
type: string
nullable: true
example: null
required:
- data
- error_code
- message
type: object
additionalProperties: false
LimitNewParamV4:
type: string
default: 100
format: string
description: Maximum number of records to return per request. Can specify 'max' to use the service
maximum.
Trade:
properties:
amount:
type: number
format: double
description: Amount
date:
type: string
description: Trade date (UTC format)
id:
type: string
description: Trade id
maker_order_id:
type: string
description: Maker order id
maker_side:
type: string
description: Maker order side (sell / buy)
maker_type:
type: string
description: Maker order type (market / limit)
price:
type: number
format: double
description: Price
pair:
type: string
description: Currency pair code
example: BTC_BRL
taker_order_id:
type: string
description: Taker order id
taker_side:
type: string
description: Taker order side (sell / buy)
taker_type:
type: string
description: Taker order type (market / limit)
timestamp:
type: number
format: double
description: Current timestamp
example: 1675708481219
total_value:
type: number
format: float
description: Total value
required:
- amount
- date
- id
- maker_order_id
- maker_side
- maker_type
- price
- pair
- taker_order_id
- taker_side
- taker_type
- timestamp
- total_value
type: object
additionalProperties: false
PaginationV4:
properties:
current_page:
type: number
format: double
description: Current page
page_size:
type: number
format: double
description: Page size
registers_count:
type: number
format: double
description: Total number of registers
total_pages:
type: number
format: double
description: Total number of pages
required:
- current_page
- page_size
- registers_count
- total_pages
type: object
additionalProperties: false
example:
current_page: 1
registers_count: 21
total_pages: 1
page_size: 100
TradesResponseData:
properties:
trades:
items:
$ref: '#/components/schemas/Trade'
type: array
example:
- amount: 0.2404764
date: '2019-01-03T02:27:33.947Z'
id: 2B222F22-5235-45FA-97FC-E9DBFA2575EE
maker_order_id: F49F5BD8-3F5B-4364-BCEE-F36F62DB966A
maker_side: buy
maker_type: limit
pair: BTC_BRL
price: 15160
taker_order_id: FEAB5CEC-7F9E-4F95-B67D-9E8D5C739BE3
taker_side: sell
taker_type: market
timestamp: 1675708481219
total_value: 3638.4
- amount: 0.00563617
date: '2019-01-03T02:27:33.943Z'
id: CDC492A5-B1BF-4353-BE7A-43F51C371388
maker_order_id: 53BF30D2-901C-43D5-B0D1-62CD05DFD02A
maker_side: buy
maker_type: limit
pair: BTC_BRL
price: 15163
taker_order_id: E4B1B38D-C871-4476-9314-3DC23292F45E
taker_side: sell
taker_type: limit
timestamp: 1675708481220
total_value: 84.91
- amount: 0.00680154
date: '2019-01-03T02:27:33.940Z'
id: 910AA20F-211F-4755-90A7-94227DB407D8
maker_order_id: 1FD30735-E055-4200-AD3D-007B02A5BA92
maker_side: buy
maker_type: limit
pair: BTC_BRL
price: 15163.03
taker_order_id: DBC6D4AF-D454-46DF-80EC-E19528A0FB25
taker_side: sell
taker_type: limit
timestamp: 1675708481221
total_value: 104.1
pagination:
$ref: '#/components/schemas/PaginationV4'
nc:
type: string
nullable: true
description: This is the next cursor, use its value with the `c` parameter to retrieve the next
page
pc:
type: string
nullable: true
description: This is the previous cursor, use its value with the `c` parameter to retrieve the
previous page
required:
- trades
type: object
additionalProperties: false
TradesResponse:
properties:
data:
$ref: '#/components/schemas/TradesResponseData'
error_code:
type: number
enum:
- null
nullable: true
example: null
message:
type: string
nullable: true
example: null
required:
- data
- error_code
- message
type: object
additionalProperties: false
StartDateTimeNoMinParamV4:
type: string
default: '[6 months ago]'
example: '2020-01-01T00:00:00-03:00'
format: datetime
description: Initial datetime filter in ISO-8601 format
EndDateTimeNoMinParamV4:
type: string
default: '[Current datetime]'
example: '2020-01-02T23:59:59-03:00'
format: datetime
description: Final datetime filter in ISO-8601 format
PageSizeParamV4:
type: number
format: int32
default: 200
example: 100
description: Number of records per page
maximum: 1000
minimum: 1
CurrentPageParamV4:
type: number
format: int32
default: 1
example: 3
description: Page number for pagination
PublicMemo:
properties:
deposit:
type: boolean
description: Flag that indicates if the network has memo for deposit
format: boolean
withdrawal:
type: boolean
description: Flag that indicates if the network has memo for withdrawal
format: boolean
required:
- deposit
- withdrawal
type: object
additionalProperties: false
PublicTag:
properties:
deposit:
type: boolean
description: Flag that indicates if the network has tag for deposit
format: boolean
withdrawal:
type: boolean
description: Flag that indicates if the network has tag for withdrawal
format: boolean
required:
- deposit
- withdrawal
type: object
additionalProperties: false
PublicNetwork:
properties:
code:
type: string
description: Network code
format: string
memo:
$ref: '#/components/schemas/PublicMemo'
description: Memo information
format: PublicTag
tag:
$ref: '#/components/schemas/PublicTag'
description: Tag information
format: PublicTag
required:
- code
- memo
- tag
type: object
additionalProperties: false
PublicCurrencyLogo:
properties:
svg:
type: string
description: Currency svg logo
format: string
required:
- svg
type: object
additionalProperties: false
PublicCurrencyV4:
properties:
active:
type: boolean
description: Whether the currency is currently active for trading
format: boolean
can_deposit:
type: boolean
description: Whether deposits are enabled for this currency
format: boolean
can_withdraw:
type: boolean
description: Whether withdrawals are enabled for this currency
format: boolean
code:
type: string
description: Currency code
example: BTC
id:
type: string
description: Currency id
format: string
min_withdraw_amount:
type: number
format: float
description: Minimum withdrawal amount
name:
type: string
description: Currency name
format: string
needs_block_id_for_tx_sync:
type: boolean
description: Whether the currency requires a block ID for transaction synchronization
format: boolean
networks:
items:
$ref: '#/components/schemas/PublicNetwork'
type: array
description: Supported networks for the currency (undefined for fiduciary currency)
format: PublicNetwork[]
precision:
type: number
format: int32
description: Currency decimal places
logo:
$ref: '#/components/schemas/PublicCurrencyLogo'
description: Currency logo
format: PublicCurrencyLogo
countries:
items:
type: string
type: array
description: Available countries
required:
- active
- can_deposit
- can_withdraw
- code
- id
- min_withdraw_amount
- name
- needs_block_id_for_tx_sync
- precision
- logo
- countries
type: object
additionalProperties: false
example:
active: true
can_deposit: true
can_withdraw: true
code: BTC
id: e7a079d8-828d-42c8-bf48-8ee3ac1862d1
min_withdraw_amount: 0.001
name: Bitcoin
needs_block_id_for_tx_sync: true
networks:
- code: bitcoin
memo:
deposit: false
withdrawal: false
tag:
deposit: false
withdrawal: false
precision: 8
countries:
- BR
- AR
logo:
svg: https://cryptocurrency-logos.ripio.com/svg/btc.svg
CurrenciesResponseV4:
properties:
data:
items:
$ref: '#/components/schemas/PublicCurrencyV4'
type: array
error_code:
type: number
enum:
- null
nullable: true
example: null
message:
type: string
nullable: true
example: null
required:
- data
- error_code
- message
type: object
additionalProperties: false
CountriesParamV4:
type: string
example: BR,AR
format: string
description: Countries (One or many, use "," to separate)
PublicPairV4:
properties:
amount_tick:
type: number
format: float
description: Smallest amount increment allowed
base:
type: string
description: Base currency code
format: string
base_name:
type: string
description: Base currency full name
format: string
quote:
type: string
description: Quote currency code
format: string
quote_name:
type: string
description: Quote currency full name
format: string
symbol:
type: string
description: 'Currency pair code (format: BASE_QUOTE)'
format: string
enabled:
type: boolean
description: Whether the pair is currently available for trading
format: boolean
min_amount:
type: number
format: float
description: Minimum order amount in base currency
price_tick:
type: number
format: float
description: Smallest price increment allowed
min_value:
type: number
format: float
description: Minimum order value in quote currency
countries:
items:
type: string
type: array
description: Available countries
max_price_variation:
type: number
format: int32
description: Maximum price variation (in percentage), applicable either upward or downward,
relative to the best price in the order book (e.g., `10` means `10%`)
required:
- amount_tick
- base
- base_name
- quote
- quote_name
- symbol
- enabled
- min_amount
- price_tick
- min_value
- countries
type: object
additionalProperties: false
example:
amount_tick: 0.0001
base: BTC
base_name: Bitcoin
enabled: true
min_amount: 0.0005
min_value: 10
price_tick: 1
quote: BRL
quote_name: Brazilian real
symbol: BTC_BRL
countries:
- BR
max_price_variation: 10
PairsResponseV4:
properties:
data:
items:
$ref: '#/components/schemas/PublicPairV4'
type: array
error_code:
type: number
enum:
- null
nullable: true
example: null
message:
type: string
nullable: true
example: null
required:
- data
- error_code
- message
type: object
additionalProperties: false
CountriesData:
properties:
name:
type: string
description: Name of the country
format: string
code:
type: string
description: Acronym of the country
format: string
required:
- name
- code
type: object
additionalProperties: false
example:
name: Brazil
code: BR
CountriesResponse:
properties:
data:
items:
$ref: '#/components/schemas/CountriesData'
type: array
error_code:
type: number
enum:
- null
nullable: true
example: null
message:
type: string
nullable: true
example: null
required:
- data
- error_code
- message
type: object
additionalProperties: false
ServerTime:
properties:
message:
type: string
nullable: true
data:
properties:
timestamp:
type: number
format: double
required:
- timestamp
type: object
required:
- message
- data
type: object
example:
data:
timestamp: 1670004661380
message: null
CursorTradesResponseData:
properties:
trades:
items:
$ref: '#/components/schemas/Trade'
type: array
example:
- amount: 0.2404764
date: '2019-01-03T02:27:33.947Z'
id: 2B222F22-5235-45FA-97FC-E9DBFA2575EE
maker_order_id: F49F5BD8-3F5B-4364-BCEE-F36F62DB966A
maker_side: buy
maker_type: limit
pair: BTC_BRL
price: 15160
taker_order_id: FEAB5CEC-7F9E-4F95-B67D-9E8D5C739BE3
taker_side: sell
taker_type: market
timestamp: 1675708481219
total_value: 3638.4
- amount: 0.00563617
date: '2019-01-03T02:27:33.943Z'
id: CDC492A5-B1BF-4353-BE7A-43F51C371388
maker_order_id: 53BF30D2-901C-43D5-B0D1-62CD05DFD02A
maker_side: buy
maker_type: limit
pair: BTC_BRL
price: 15163
taker_order_id: E4B1B38D-C871-4476-9314-3DC23292F45E
taker_side: sell
taker_type: limit
timestamp: 1675708481220
total_value: 84.91
- amount: 0.00680154
date: '2019-01-03T02:27:33.940Z'
id: 910AA20F-211F-4755-90A7-94227DB407D8
maker_order_id: 1FD30735-E055-4200-AD3D-007B02A5BA92
maker_side: buy
maker_type: limit
pair: BTC_BRL
price: 15163.03
taker_order_id: DBC6D4AF-D454-46DF-80EC-E19528A0FB25
taker_side: sell
taker_type: limit
timestamp: 1675708481221
total_value: 104.1
nc:
type: string
nullable: true
description: This is the next cursor, use its value with the `c` parameter to retrieve the next
page
pc:
type: string
nullable: true
description: This is the previous cursor, use its value with the `c` parameter to retrieve the
previous page
required:
- trades
type: object
additionalProperties: false
CursorTradesResponse:
properties:
data:
$ref: '#/components/schemas/CursorTradesResponseData'
error_code:
type: number
enum:
- null
nullable: true
example: null
message:
type: string
nullable: true
example: null
required:
- data
- error_code
- message
type: object
additionalProperties: false
BookOrderLevel3:
properties:
amount:
type: number
format: float
description: Amount
id:
type: string
description: Order id
format: string
price:
type: number
format: int32
description: Price
required:
- amount
- id
- price
type: object
additionalProperties: false
OrdersLevel3Data:
properties:
timestamp:
type: number
format: double
description: Current timestamp
example: 1675708481219
asks:
items:
$ref: '#/components/schemas/BookOrderLevel3'
type: array
description: Sell orders
example:
- amount: 0.1283746
id: 554F2D70-04B9-4E26-9548-9C35B025A018
price: 1923847
bids:
items:
$ref: '#/components/schemas/BookOrderLevel3'
type: array
description: Buy orders
example:
- amount: 0.256566
id: E6D05F51-D79B-47CF-84C5-B157120EBC25
price: 1915200
hash:
type: string
description: Hash of asks and bids
example: '16757084812196786445'
required:
- timestamp
- asks
- bids
- hash
type: object
additionalProperties: false
BookOrdersLevel3Response:
properties:
data:
$ref: '#/components/schemas/OrdersLevel3Data'
error_code:
type: number
enum:
- null
nullable: true
example: null
message:
type: string
nullable: true
example: null
required:
- data
- error_code
- message
type: object
additionalProperties: false
Pick_BookOrderLevel3.Exclude_keyofBookOrderLevel3.id__:
properties:
amount:
type: number
format: float
description: Amount
price:
type: number
format: int32
description: Price
required:
- amount
- price
type: object
description: From T, pick a set of properties whose keys are in the union K
Omit_BookOrderLevel3.id_:
$ref: '#/components/schemas/Pick_BookOrderLevel3.Exclude_keyofBookOrderLevel3.id__'
description: Construct a type with the properties of T except for those in type K.
BookOrderLevel2:
$ref: '#/components/schemas/Omit_BookOrderLevel3.id_'
OrdersLevel2Data:
properties:
timestamp:
type: number
format: double
description: Current timestamp
example: 1675708481219
asks:
items:
$ref: '#/components/schemas/BookOrderLevel2'
type: array
description: Sell orders
example:
- amount: 0.1283746
price: 1923847
bids:
items:
$ref: '#/components/schemas/BookOrderLevel2'
type: array
description: Buy orders
example:
- amount: 0.1283746
price: 1923847
required:
- timestamp
- asks
- bids
type: object
additionalProperties: false
BookOrdersLevel2Response:
properties:
data:
$ref: '#/components/schemas/OrdersLevel2Data'
error_code:
type: number
enum:
- null
nullable: true
example: null
message:
type: string
nullable: true
example: null
required:
- data
- error_code
- message
type: object
additionalProperties: false
UserPreparedOrder:
properties:
id:
type: string
description: Order identifier
create_date:
type: string
description: Creation datetime
executed_amount:
type: number
format: float
description: Executed amount
external_id:
type: str
# --- truncated at 32 KB (289 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ripio/refs/heads/main/openapi/ripio-trade-openapi.yml