Ajaib · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Ajaib Coin Exchange API

17 actions 17 updates update extends openapi/ajaib-coin-exchange-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Ajaib's API. It is a proposal applied on top of the contract, not a document Ajaib publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-agentic-accessx-cautionx-paginationx-apievangelist-profilex-apievangelist-sourcex-apievangelist-spec-originx-conventionsx-error-catalog

Targets 15

$.info
$.servers
$.paths['/coin/internal/v1/order'].post
$.paths['/coin/internal/v1/order/batch'].post
$.paths['/coin/internal/v1/order/self-trading'].post
$.paths['/coin/internal/v1/order'].delete
$.paths['/coin/internal/v1/order/batch'].delete
$.paths['/coin/internal/v1/order/open'].delete
$.paths['/coin/internal/v1/public/time'].get
$.paths['/coin/internal/v1/public/exchange-info'].get
$.paths['/coin/internal/v1/depth'].get
$.paths['/coin/internal/v1/price'].get
$.paths['/coin/internal/v1/portfolio'].get
$.paths['/coin/internal/v1/trades'].get
$.paths['/coin/internal/v1/order/open'].get

OpenAPI Overlay

Raw ↑
overlay: 1.0.0
info:
  title: API Evangelist enhancements for Ajaib Coin Exchange API
  version: 1.0.0
extends: openapi/ajaib-coin-exchange-openapi.yml
x-provenance:
  generated: '2026-08-06'
  method: generated
  source: >-
    Derived from API Evangelist artifacts in all/ajaib/ (conventions, errors,
    lifecycle, authentication, data-model, mcp).
actions:
- target: $.info
  update:
    x-apievangelist-profile: https://apievangelist.com/providers/ajaib
    x-apievangelist-source: https://ajaib.gitbook.io/coin-exchange
    x-apievangelist-spec-origin: >-
      Generated by API Evangelist from Ajaib's published GitBook reference.
      Ajaib publishes no OpenAPI document of its own.
- target: $.info
  update:
    x-conventions: conventions/ajaib-conventions.yml
    x-error-catalog: errors/ajaib-error-codes.yml
    x-lifecycle: lifecycle/ajaib-lifecycle.yml
    x-authentication: authentication/ajaib-authentication.yml
    x-data-model: data-model/ajaib-data-model.yml
    x-sandbox: sandbox/ajaib-sandbox.yml
- target: $.info
  update:
    x-rate-limit-signal:
      documented_headers: []
      status: 429
      guidance: Use an exponential backoff on your request.
- target: $.servers
  update:
  - x-environment: production
  - x-environment: sandbox
- target: $.paths['/coin/internal/v1/order'].post
  update:
    x-agentic-access:
      action-class: acting
      consequence: physical
      audit: required
      idempotency: undocumented
    x-caution: >-
      Places a real order against real funds. No idempotency key is documented,
      so a blind retry can duplicate the order.
- target: $.paths['/coin/internal/v1/order/batch'].post
  update:
    x-agentic-access:
      action-class: acting
      consequence: physical
      audit: required
      idempotency: undocumented
    x-caution: >-
      Partial success is possible; the response is a per-order array, not an
      all-or-nothing result.
- target: $.paths['/coin/internal/v1/order/self-trading'].post
  update:
    x-agentic-access:
      action-class: acting
      consequence: physical
      audit: required
    x-availability: internal-market-maker-clients-only
- target: $.paths['/coin/internal/v1/order'].delete
  update:
    x-agentic-access:
      action-class: acting
      consequence: physical
      audit: required
- target: $.paths['/coin/internal/v1/order/batch'].delete
  update:
    x-agentic-access:
      action-class: acting
      consequence: physical
      audit: required
    x-caution: >-
      Returns a success array and a fail array; check both.
- target: $.paths['/coin/internal/v1/order/open'].delete
  update:
    x-agentic-access:
      action-class: acting
      consequence: physical
      audit: required
      human-in-the-loop: recommended
    x-caution: Cancels every open order on the trading pair in one call.
- target: $.paths['/coin/internal/v1/public/time'].get
  update:
    x-agentic-access:
      action-class: connected
      consequence: read
    x-note: >-
      Use this to align X-TIMESTAMP with exchange time before signing
      authenticated requests.
- target: $.paths['/coin/internal/v1/public/exchange-info'].get
  update:
    x-agentic-access:
      action-class: connected
      consequence: read
- target: $.paths['/coin/internal/v1/depth'].get
  update:
    x-agentic-access:
      action-class: connected
      consequence: read
- target: $.paths['/coin/internal/v1/price'].get
  update:
    x-agentic-access:
      action-class: connected
      consequence: read
- target: $.paths['/coin/internal/v1/portfolio'].get
  update:
    x-agentic-access:
      action-class: connected
      consequence: read
- target: $.paths['/coin/internal/v1/trades'].get
  update:
    x-agentic-access:
      action-class: connected
      consequence: read
    x-pagination:
      cursor: from_trade_id
      exclusive: true
      limit: limit
- target: $.paths['/coin/internal/v1/order/open'].get
  update:
    x-agentic-access:
      action-class: connected
      consequence: read
    x-pagination:
      cursor: from_order_id
      exclusive: false
      limit: limit