For the complete documentation index, see llms.txt. This page is also available as Markdown.

Trading

Trading and wallet operations

post

Handles all trading actions (swap, balance inquiries, withdrawals, key export). The specific operation is selected via the action query parameter. All actions require authentication.

Authorizations
X-API-KEYstringRequired

API key with the ix_ prefix. You can generate an API Key by navigating to Settings -> API Key in the web app. Pass it in the X-API-KEY header on every request.

Query parameters
actionstring · enumRequired

The trading action to perform.

Possible values:
Body
or
or
or
Responses
200

Successful response. Shape depends on action.

application/json
or
or
or
or
or
or
object · WithdrawUsdcResponseOptional

Transaction details for the withdrawal.

or
post/api/txn.php
POST /api/txn.php?action=swap HTTP/1.1
Host: api.indexify.finance
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "stack_id": 1,
  "amount": 1,
  "cue": "fromUSDC"
}
{
  "order_id": "text"
}

Order management

post

Provides order details, partial order handling, retry, sell-all, and retry chain lookups. All actions require authentication and an order_id in the request body.

Authorizations
X-API-KEYstringRequired

API key with the ix_ prefix. You can generate an API Key by navigating to Settings -> API Key in the web app. Pass it in the X-API-KEY header on every request.

Query parameters
actionstring · enumOptional

The order action to perform. Defaults to details.

Default: detailsPossible values:
Body
or
Responses
200

Successful response. Shape depends on action.

application/json
or
or
or
or
or
post/api/orders.php
POST /api/orders.php HTTP/1.1
Host: api.indexify.finance
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "order_id": "text"
}
{
  "order": {
    "order_id": "text",
    "status": "PENDING",
    "type": "fromUSDC",
    "created_at": "text",
    "partial_completion_action": "text"
  },
  "transactions": [
    {
      "order_id": "text",
      "success": true,
      "txn_hash": "text"
    }
  ],
  "transaction_count": 1
}

List authenticated user's orders

post

Returns a paginated list of all orders for the authenticated user.

Authorizations
X-API-KEYstringRequired

API key with the ix_ prefix. You can generate an API Key by navigating to Settings -> API Key in the web app. Pass it in the X-API-KEY header on every request.

Query parameters
offsetintegerOptional

Pagination offset.

Default: 0
limitinteger · min: 1 · max: 100Optional

Number of orders to return.

Default: 100
Responses
200

Paginated list of user orders.

application/json
post/api/user_orders.php
POST /api/user_orders.php HTTP/1.1
Host: api.indexify.finance
X-API-KEY: YOUR_API_KEY
Accept: */*
{
  "orders": [
    {
      "order_id": "text",
      "stack_id": 1,
      "type": "fromUSDC",
      "status": "PENDING",
      "created_at": "text",
      "parent_order_id": "text",
      "retry_attempt": 1,
      "partial_completion_action": "text",
      "stack_name": "text",
      "stack_symbol": "text"
    }
  ],
  "pagination": {
    "offset": 1,
    "limit": 1,
    "total_count": 1,
    "has_more": true,
    "has_previous": true,
    "page": 1,
    "per_page": 1,
    "total_pages": 1
  }
}

List outstanding partial orders for a stack

post

Returns a paginated list of the authenticated user's outstanding partial orders (status=PARTIAL, partial_completion_action=pending) for a given stack.

Authorizations
X-API-KEYstringRequired

API key with the ix_ prefix. You can generate an API Key by navigating to Settings -> API Key in the web app. Pass it in the X-API-KEY header on every request.

Query parameters
stack_idintegerRequired

ID of the stack to query.

offsetintegerOptional

Pagination offset.

Default: 0
limitinteger · min: 1 · max: 100Optional

Number of orders to return.

Default: 100
Responses
200

Paginated list of outstanding partial orders.

application/json
post/api/stack_partial_orders.php
POST /api/stack_partial_orders.php?stack_id=1 HTTP/1.1
Host: api.indexify.finance
X-API-KEY: YOUR_API_KEY
Accept: */*
{
  "stack": {
    "id": 1,
    "stack_name": "text",
    "stack_token_name": "text"
  },
  "outstanding_partial_orders": [
    {
      "order_id": "text",
      "user_id": 1,
      "stack_id": 1,
      "type": "text",
      "status": "text",
      "usdc_amount": 1,
      "creator_fee": 1,
      "platform_fee": 1,
      "expected_amount": 1,
      "created_at": "text",
      "parent_order_id": "text",
      "retry_attempt": 1,
      "partial_completion_action": "text",
      "username": "text"
    }
  ],
  "pagination": {
    "offset": 1,
    "limit": 1,
    "total_count": 1,
    "has_more": true,
    "has_previous": true,
    "page": 1,
    "per_page": 1,
    "total_pages": 1
  }
}

Transaction history

get

Retrieve the authenticated user's transaction history, a single transaction detail, or a transaction summary. The specific operation is selected via the action query parameter.

Authorizations
X-API-KEYstringRequired

API key with the ix_ prefix. You can generate an API Key by navigating to Settings -> API Key in the web app. Pass it in the X-API-KEY header on every request.

Query parameters
actionstring · enumOptional

The history action to perform.

Default: listPossible values:
offsetintegerOptional

Pagination offset (action=list only).

Default: 0
limitinteger · min: 1 · max: 100Optional

Number of transactions to return (action=list only).

Default: 20
typestring · enumOptional

Filter by transaction type (action=list only).

Possible values:
statusstring · enumOptional

Filter by transaction status (action=list only).

Possible values:
stack_idintegerOptional

Filter by stack ID (action=list only). Cannot be combined with token_address.

token_addressstringOptional

Filter by token address (action=list only). Cannot be combined with stack_id.

order_idstringOptional

Order ID to look up (action=detail only, required for detail).

Responses
200

Successful response. Shape depends on action.

application/json
or
or
get/api/transaction_history.php
GET /api/transaction_history.php HTTP/1.1
Host: api.indexify.finance
X-API-KEY: YOUR_API_KEY
Accept: */*
{
  "transactions": [
    {
      "order_id": "text",
      "stack_id": 1,
      "transaction_type": "buy",
      "status": "PENDING",
      "usdc_amount": 1,
      "expected_amount": 1,
      "sell_percentage": 1,
      "slippage": 1,
      "creator_fee": 1,
      "platform_fee": 1,
      "created_at": "text",
      "updated_at": "text",
      "parent_order_id": "text",
      "retry_attempt": 1,
      "partial_completion_action": "text",
      "is_company_stack": true,
      "asset": {
        "type": "text",
        "name": "text",
        "slug": "text",
        "symbol": "text",
        "address": "text",
        "image_url": "text",
        "archived": true
      },
      "tokens": [
        {}
      ],
      "transaction_hash": "text",
      "from_wallet": "text",
      "to_wallet": "text",
      "block_slot": 1
    }
  ],
  "pagination": {
    "offset": 1,
    "limit": 1,
    "total_count": 1,
    "has_more": true,
    "has_previous": true,
    "page": 1,
    "total_pages": 1
  }
}

Fee calculations and bounds

post

Calculate trading fees, retrieve minimum buy amount, or get creator fee bounds. No authentication required.

Authorizations
X-API-KEYstringRequired

API key with the ix_ prefix. You can generate an API Key by navigating to Settings -> API Key in the web app. Pass it in the X-API-KEY header on every request.

Query parameters
actionstring · enumRequired

The fee action to perform.

Possible values:
Body
Responses
200

Successful response. Shape depends on action.

application/json
or
or
post/api/fee.php
POST /api/fee.php?action=calculate HTTP/1.1
Host: api.indexify.finance
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "amount": 1,
  "stack_id": 1
}
{
  "fee_display": "text",
  "estimated_blockchain_fees_saved": "text"
}

Last updated