Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Ripio Orders API

The Orders API from Ripio — 11 operation(s) for orders.

Ripio Orders API is one of 11 APIs that Ripio publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Orders. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 14 operations across 11 paths, and defines 49 schemas. It is described by OpenAPI 3.0.0, at version v4.0.

Requests are made against a single base URL, https://api.ripiotrade.co/v4/.

14 operations 11 paths 49 schemas 3 DELETE7 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v4.0
Base URL
https://api.ripiotrade.co/v4/
Authentication
apiToken
Contact
Jorn Filho
Resource Areas
1

Authentication & Security 1

Ripio Orders API declares 1 security scheme for authenticating requests. It defines a apiToken scheme (API Credentials).

  • API Credentials — You can create API Credentials on: . After creating the API Credentials, you'll need to save in a safe place two pieces of information, an API Token and a Secr…

Paths & Operations 14

Across 11 paths, the API surfaces 14 operations — 3 DELETE, 7 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Orders 14
GET
/trades
Trades
GetTrades 5 params → 200
GET
/orders
User Orders
GetUserOrders 10 params → 200
POST
/orders
Create Order
CreateOrder body → 200
DELETE
/orders
Cancel Order
CancelOrder body → 200
PUT
/orders
Update the amount and/or price of an order
UpdatePriceAmountOrderOnMarket body → 200
GET
/orders/open
Get User Open Orders
GetUserOpenOrders 5 params → 200
GET
/orders/trades
Get Trades based on a order id
GetTrades 3 params → 200
GET
/orders/{id}
User Order by Id
GetOrderById 1 param → 200
GET
/orders/by-external-id/{external_id}
User Order by External Id
GetOrderByExternalId 1 param → 200
POST
/orders/cancel
Cancel Order
CancelOrderByPost body → 200
DELETE
/orders/by-external-id
Cancel Order By External Id
CancelOrderByExternalId body → 200
POST
/orders/cancel-by-external-id
Cancel Order By External Id
CancelOrderByExternalIdByPost body → 200
DELETE
/orders/all
Cancel All Orders
CancelAllOrders body → 200
GET
/orders/estimate-price/{pair}
Estimate Price
EstimatePrice 3 params → 200

Schemas 49

The contract defines 49 schemas that model the data the API accepts and returns. The most detailed are UserPreparedOrderWithExecutions (19 properties), UserPreparedOrder (17 properties), UserPreparedTradeV4 (14 properties), CancelResponseData (14 properties). Each schema is shown below with its type and property counts.

UserOrdersDataV4
object
4 properties 2 required
Trade
object
13 properties 13 required
StartDateTimeNoMinParamV4
string
Initial datetime filter in ISO-8601 format
OrderIdsParamV4
string
Identifiers list separated by commas (maximum of 10 identifiers)
CeilingBuyOrderBody
object
6 properties 4 required
UserOrdersResponseV4
object
3 properties 3 required
PaginationV4
object
4 properties 4 required
UserTradesDataV4
object
4 properties 2 required
CancelAllOrdersData
object
3 properties 3 required
EndDateTimeNoMinParamV4
string
Final datetime filter in ISO-8601 format
EstimatedPriceResponseDataV4
object
1 property 1 required
CursorTradesResponseData
object
3 properties 1 required
UserTradesResponseV4
object
3 properties 3 required
CancelResponseData
object
14 properties 11 required
MarketBuyOrderBody
object
7 properties 5 required
UserPreparedTradeV4
object
14 properties 14 required
OrderIdParamV4
string
Order identifier
UserOpenOrdersResponseV4
object
3 properties 3 required
EndDateParamV4
string
Final date filter in ISO-8601 format (the interval between the initial and final date shouldn't be greater than 6 months)
OrderTypeParamV4
string
Order type (limit, market, stoplimit, trailing, ceiling or iceberg)
VoidResponse
object
3 properties 3 required
StopLimitBuyOrderBody
object
7 properties 6 required
MarketSellOrderBody
object
7 properties 5 required
UserOrderResponse
object
3 properties 3 required
TrailingBuyOrderBody
object
7 properties 6 required
CancelAllOrdersResponse
object
3 properties 3 required
CancelOrderResponse
object
3 properties 3 required
OrderUpdatePriceAmountOrderOnMarketBody
object
3 properties 1 required
StopLimitSellOrderBody
object
7 properties 6 required
UserOrderOutput
object
11 properties 9 required
PageSizeParamV4
number
Number of records per page
UserOrderTransactions
object
6 properties 6 required
StartDateParamV4
string
Initial date filter in ISO-8601 format (shouldn't be before 2017-10-01)
CursorTradesResponse
object
3 properties 3 required
UserPreparedOrder
object
17 properties 15 required
OrderExternalIdParamV4
string
Order external identifier (maximum of 36 chars)
IcebergBuyOrderBody
object
7 properties 6 required
TrailingSellOrderBody
object
7 properties 6 required
LimitSellOrderBody
object
10 properties 5 required
OrderStatusParamV4
string
Order status (string or string list separated by commas)
UserOpenOrdersDataV4
object
4 properties 2 required
UserPreparedOrderWithExecutions
object
19 properties 16 required
LimitBuyOrderBody
object
10 properties 5 required
OrderSideParamV4
string
Order side (buy or sell)
CurrentPageParamV4
number
Page number for pagination
IcebergSellOrderBody
object
7 properties 6 required
EstimatedPriceResponseV4
object
3 properties 3 required
CreateOrderResponse
object
3 properties 3 required
CeilingSellOrderBody
object
6 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ripio-orders-api-openapi.yml Raw ↑

Other APIs Ripio publishes across the network.

Ripio Book API
Ripio Cryptocurrency Deposits API
Ripio Cryptocurrency Withdrawals API
Ripio General endpoints API
Ripio Public API
Ripio Ticker API
Ripio Ticket API
Ripio Transactions API
Ripio User API
Ripio Wallets API