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 Instruments API

Instrument and market information

Ribbon Finance Instruments 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 Instruments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 3 operations across 3 paths, and defines 2 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.

3 operations 3 paths 2 schemas 3 GET

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 Instruments 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 3

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

Instruments 3

Instrument and market information

GET
/markets
Get markets
getMarkets 2 params → 200400429500
GET
/assets
Get available assets
getAssets → 200429500
GET
/expiries
Get available expiries
getExpiries 1 param → 200400429500

Schemas 2

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

ErrorResponse
object
1 property
Instrument
object
19 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ribbon-finance-instruments-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 Market Data API
Ribbon Finance Orders API
Ribbon Finance Positions API
Ribbon Finance Statistics API
Ribbon Finance Trade History API