Get started

Endpoints · Public

OpenAPI document

The OpenAPI 3.1 description of this API. Use it to generate a client or import the API into a tool.

GET/api/v1/openapi.json

Public, no key

Parameters

No parameters.

Request
curl https://yieldsniper.finance/api/v1/openapi.json
Response200
{
  "openapi": "3.1.0",
  "info": {
    "title": "Yield Sniper API",
    "version": "1.0.0",
    "summary": "Risk-screened DeFi yield data: instruments, daily screens, reports and the methodology behind them.",
    …
  },
  "servers": [
    {
      "url": "https://yieldsniper.finance/api/v1",
      "description": "Production"
    }
  ],
  "paths": {
    "/instruments": {
      "get": {
        "operationId": "listInstruments",
        …
      }
    },
    …
  },
  …
}

Returns

An OpenAPI 3.1 document.