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

Ribbon Finance Orders API

Order management endpoints

Ribbon Finance Orders API is one of 10 APIs that Ribbon Finance 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 authentication docs.

This API exposes 8 operations across 4 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against a single base URL, https://api.aevo.xyz.

8 operations 4 paths 3 schemas 2 DELETE3 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.aevo.xyz
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Ribbon Finance Orders API declares 2 security schemes for authenticating requests. An API key is passed in the header as AEVO-KEY (AevoKey). An API key is passed in the header as AEVO-SECRET (AevoSecret). By default, every request must be authenticated.

  • AevoKey — API key obtained from Aevo account settings
  • AevoSecret — API secret obtained from Aevo account settings

Paths & Operations 8

Across 4 paths, the API surfaces 8 operations — 2 DELETE, 3 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Orders 8

Order management endpoints

GET
/orders
Get open orders
getOrders → 200401429500
POST
/orders
Create order
postOrders body → 200400401429500
DELETE
/orders
Cancel all orders
deleteOrdersAll → 200401429500
GET
/orders/{order_id}
Get order by ID
getOrderById 1 param → 200401429500
POST
/orders/{order_id}
Amend order
amendOrder 1 param body → 200401429500
DELETE
/orders/{order_id}
Cancel order
deleteOrder 1 param → 200401429500
GET
/order-history
Get order history
getOrderHistory 4 params → 200401429500
POST
/batch-orders
Place batch orders
postBatchOrders body → 200400401429500

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Order (23 properties), CreateOrderRequest (19 properties), ErrorResponse (1 property). Each schema is shown below with its type and property counts.

CreateOrderRequest
object
19 properties 8 required
Order
object
23 properties
ErrorResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ribbon-finance-orders-api-openapi.yml Raw ↑

Other APIs Ribbon Finance publishes across the network.

Aevo Exchange WebSocket API
Ribbon Finance Subgraph API
Ribbon Finance Account API
Ribbon Finance API Keys API
Ribbon Finance Instruments API
Ribbon Finance Market Data API
Ribbon Finance Positions API
Ribbon Finance Statistics API
Ribbon Finance Trade History API