Skip to content

Query Pending Corporate Actions

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

Description: Get all pending corporate actions

Authentication: JWT token in Authorization header

Request Parameters:

FieldTypeRequiredDescription
tokenstringNoURL parameter, stock token address

Response Parameters

FieldTypeDescription
codeintResult code. 0 for success
dataobjectResult object
data.actionsobject arrayCorporate action object array
data.actions[].iduuidAction record id
data.actions[].makerstringMaker
data.actions[].holding_qtystringHolding quantity
data.actions[].token_addressstringStock token address
data.actions[].action_qtystringExecution quantity
data.actions[].action_typeenumAction type (dividend, stock_split, reverse_stock_split, delisting)
data.actions[].compensation_qtystringCompensation quantity
data.actions[].create_atstringCreation time
data.actions[].paramsobjectOther parameters

Dividend params

FieldTypeDescription
data.actions[].params.dividend_per_sharestringDividend amount per token
data.actions[].params.tax_ratestringDividend tax rate %
data.actions[].params.fee_amountstringFee (USD)

Stock Split params

FieldTypeDescription
data.actions[].params.split_ratiostringSplit ratio
data.actions[].params.compensation_per_sharestringCompensation amount per share
data.actions[].params.fee_amountstringFee (USD)

Reverse Stock Split params

FieldTypeDescription
data.actions[].params.merge_ratiostringMerge ratio
data.actions[].params.compensation_per_sharestringCompensation amount per share
data.actions[].params.fee_amountstringFee (USD)

Delisting params

FieldTypeDescription
data.actions[].params.compensation_per_sharestringCompensation amount per share
data.actions[].params.fee_amountstringFee (USD)

Request Example

bash
# Query all pending corporate actions
curl "api/v1/corporate-actions/maker/0x5fc23eB93208F58e29A1AC493dc15FD0b0Cb5C92/pending"

# Query pending corporate actions for a specific token
curl "api/v1/corporate-actions/maker/0x5fc23eB93208F58e29A1AC493dc15FD0b0Cb5C92/pending?token=0x1c6611cde556f439252c2845c33702c3035fe351"

Response Example

json
{
  "code": 0,
  "data": {
    "actions": [
      {
        "id": "string",
        "maker": "string",
        "holding_qty": "string",
        "action_qty": "string", 
        "compensation_qty": "string",
        "created_at": "2024-01-01T00:00:00Z",
        "token_address": "string",
        "action_type": "string",
        "params": {}
      }
    ],
    "total_count": 0
  }
}