OpenAPI Specification
openapi: 3.0.3
info:
title: Aevo Exchange Private REST Account API Keys API
description: Authenticated REST API for Aevo exchange providing account management, order placement and management, position tracking, portfolio data, transfers, withdrawals, and trading history. Requires AEVO-KEY and AEVO-SECRET authentication headers obtained via cryptographic key registration.
version: 1.0.0
contact:
name: Aevo Support
url: https://docs.aevo.xyz/
servers:
- url: https://api.aevo.xyz
description: Aevo Exchange production server
security:
- AevoKey: []
AevoSecret: []
tags:
- name: API Keys
description: API key management
paths:
/api-key:
get:
tags:
- API Keys
summary: Get API keys
description: Returns the API keys associated with the authenticated account.
operationId: getApiKey
responses:
'200':
description: API key list
content:
application/json:
schema:
type: object
'401':
$ref: '#/components/responses/Unauthorized'
'500':
$ref: '#/components/responses/InternalError'
post:
tags:
- API Keys
summary: Create API key
description: Creates a new API key for the authenticated account.
operationId: postApiKey
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
permissions:
type: array
items:
type: string
responses:
'200':
description: API key created
'401':
$ref: '#/components/responses/Unauthorized'
'500':
$ref: '#/components/responses/InternalError'
delete:
tags:
- API Keys
summary: Delete API key
description: Deletes an API key from the authenticated account.
operationId: deleteApiKey
responses:
'200':
description: API key deleted
'401':
$ref: '#/components/responses/Unauthorized'
'500':
$ref: '#/components/responses/InternalError'
components:
responses:
InternalError:
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
Unauthorized:
description: Unauthorized - missing or invalid authentication
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
schemas:
ErrorResponse:
type: object
properties:
error:
type: string
securitySchemes:
AevoKey:
type: apiKey
in: header
name: AEVO-KEY
description: API key obtained from Aevo account settings
AevoSecret:
type: apiKey
in: header
name: AEVO-SECRET
description: API secret obtained from Aevo account settings