Query Corporate Action Records

Endpoint: GET /api/v1/maker/corporate-actions/actions

Description: Query corporate action records for the current Maker address, returning records with status triggered (pending) and processed (completed)

Authentication: API Key + Signature. See Authorization

Request Parameters

Field	Type	Required	Description
token	string	No	URL parameter, filter by token contract address
chain_id	integer	No	URL parameter, filter by chain ID
page	integer	No	URL parameter, page number, default 1
page_size	integer	No	URL parameter, items per page, default 20

Response Parameters

Field	Type	Description
actions	array	List of corporate action records
actions[].id	string	Record UUID
actions[].maker	string	Maker wallet address
actions[].chain_id	integer	Chain ID
actions[].holding_qty	string	Pre-action holding quantity (off-chain standard value)
actions[].action_qty	string	Post-action quantity; same as holding_qty for dividend; "0" for delisting
actions[].compensation_qty	string|null	Fractional share quantity (off-chain standard value)
actions[].status	string	Record status: triggered (pending) / processed (completed)
actions[].is_token_locked	boolean	Whether the Maker's token is locked for this corporate action
actions[].created_at	string|null	Creation time (ISO 8601)
actions[].updated_at	string|null	Last update time (ISO 8601)
actions[].processed_hash	string|null	On-chain transaction hash after processing, null before processing
actions[].processed_at	string|null	Processing completion time (ISO 8601), null before processing
actions[].remark	string|null	Remark, records error message on failure
actions[].tax_rate	string|null	Admin-confirmed dividend tax rate (integer percentage, e.g. "10" means 10%)
actions[].original_fee_amount	string|null	Admin-confirmed pre-conversion fee (original currency, e.g. USD/HKD)
actions[].original_net_amount	string|null	Admin-confirmed pre-conversion net dividend amount (original currency)
actions[].original_compensation_amount	string|null	Admin-confirmed pre-conversion compensation amount (original currency)
actions[].token_address	string|null	Stock token contract address
actions[].action_type	string|null	Corporate action type: dividend / stock_split / reverse_stock_split / delisting / ticker_change
actions[].params	object|null	Plan default parameters, structure varies by action_type
actions[].ticker	string|null	Underlying stock ticker
actions[].exchange	integer|null	Exchange identifier
total_count	integer	Total number of matching records

Request Example

curl -X GET "/api/v1/maker/corporate-actions/actions?page=1&page_size=20" \
     -H "X-API-Key: YOUR_API_KEY" \
     -H "X-Maker-Addr: YOUR_MAKER_ADDRESS" \
     -H "X-API-Timestamp: 1715100000000" \
     -H "X-API-Signature: GENERATED_SIGNATURE" \
     -H "Content-Type: application/json"

Response Example

{
  "code": 0,
  "data": {
    "actions": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "maker": "0x5fc23eB93208F58e29A1AC493dc15FD0b0Cb5C92",
        "chain_id": 56,
        "holding_qty": "1000",
        "action_qty": "1000",
        "compensation_qty": "0",
        "status": "triggered",
        "is_token_locked": false,
        "created_at": "2024-12-01T10:00:00Z",
        "updated_at": "2024-12-01T10:00:00Z",
        "processed_hash": null,
        "processed_at": null,
        "remark": null,
        "tax_rate": "10",
        "original_fee_amount": "0.5",
        "original_net_amount": "22.5",
        "original_compensation_amount": null,
        "token_address": "0x1c6611cde556f439252c2845c33702c3035fe351",
        "action_type": "dividend",
        "params": {
          "type": "dividend",
          "dividend_per_share": "2.5",
          "tax_rate": 10,
          "fee_amount": "3",
          "ex_dividend_date": "2024-12-20",
          "dividend_date": "2024-12-31",
          "distribution_plan": "Cash dividend of $2.50 per share"
        },
        "ticker": "AAPLs",
        "exchange": 0
      }
    ],
    "total_count": 1
  }
}