API

Модели

Объект Plugin

{
  "Plugin": {
    "type": "object",
    "required": [
      "address",
      "type"
    ],
    "properties": {
      "address": {
        "type": "string"
      },
      "type": {
        "type": "string"
      },
      "lp_manager_index": {
        "type": "integer",
        "nullable": true,
        "description": "LP Manager index (v6.1+), null for other plugin types."
      },
      "lp_jetton_master_address": {
        "type": "string",
        "nullable": true,
        "description": "LP token jetton master address (only for LP Manager)."
      },
      "lp_token_name": {
        "type": "string",
        "nullable": true
      },
      "lp_token_symbol": {
        "type": "string",
        "nullable": true
      },
      "lp_token_image": {
        "type": "string",
        "nullable": true
      },
      "subaccount_index": {
        "type": "integer",
        "nullable": true
      },
      "subaccount_name": {
        "type": "string",
        "nullable": true
      }
    }
  }
}

Объект Holder

{
  "Holder": {
    "type": "object",
    "required": [
      "jetton_wallet_address",
      "owner_address",
      "balance"
    ],
    "properties": {
      "jetton_wallet_address": {
        "type": "string"
      },
      "owner_address": {
        "type": "string"
      },
      "balance": {
        "type": "string"
      }
    }
  }
}

Объект Dao

{
  "Dao": {
    "type": "object",
    "required": [
      "address",
      "owner_address",
      "name",
      "jetton_address",
      "jetton_metadata",
      "success_percentage",
      "total_supply",
      "plugins",
      "date_create",
      "crowdfunding_status"
    ],
    "properties": {
      "address": {
        "type": "string"
      },
      "owner_address": {
        "type": "string"
      },
      "name": {
        "type": "string"
      },
      "jetton_address": {
        "type": "string"
      },
      "jetton_metadata": {
        "type": "object",
        "additionalProperties": true
      },
      "success_percentage": {
        "type": "number"
      },
      "total_supply": {
        "type": "string"
      },
      "date_create": {
        "type": "string"
      },
      "plugins": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/Plugin"
        }
      },
      "crowdfunding_status": {
        "type": "string",
        "enum": [
          "legacy",
          "enabled",
          "ready"
        ]
      }
    }
  },
  "Plugin": {
    "type": "object",
    "required": [
      "address",
      "type"
    ],
    "properties": {
      "address": {
        "type": "string"
      },
      "type": {
        "type": "string"
      },
      "lp_manager_index": {
        "type": "integer",
        "nullable": true,
        "description": "LP Manager index (v6.1+), null for other plugin types."
      },
      "lp_jetton_master_address": {
        "type": "string",
        "nullable": true,
        "description": "LP token jetton master address (only for LP Manager)."
      },
      "lp_token_name": {
        "type": "string",
        "nullable": true
      },
      "lp_token_symbol": {
        "type": "string",
        "nullable": true
      },
      "lp_token_image": {
        "type": "string",
        "nullable": true
      },
      "subaccount_index": {
        "type": "integer",
        "nullable": true
      },
      "subaccount_name": {
        "type": "string",
        "nullable": true
      }
    }
  }
}

Объект Vote

{
  "Vote": {
    "type": "object",
    "required": [
      "proposal_address",
      "voter_address",
      "amount",
      "date_create"
    ],
    "properties": {
      "proposal_address": {
        "type": "string"
      },
      "voter_address": {
        "type": "string"
      },
      "amount": {
        "type": "string"
      },
      "date_create": {
        "type": "string"
      }
    }
  }
}

Объект ProposalStatus

{
  "ProposalStatus": {
    "type": "string",
    "enum": [
      "active",
      "rejected",
      "executed",
      "mine",
      "unknown"
    ]
  }
}

Объект Proposal

{
  "Proposal": {
    "type": "object",
    "required": [
      "proposal_id",
      "address",
      "dao_address",
      "jetton_master_address",
      "initiated_by_address",
      "success_amount",
      "current_amount",
      "total_supply",
      "success_percentage",
      "date_start",
      "date_expire",
      "type",
      "data",
      "status",
      "raw_data",
      "dao"
    ],
    "properties": {
      "proposal_id": {
        "type": "integer",
        "format": "int64"
      },
      "name": {
        "type": "string"
      },
      "is_user_voted": {
        "type": "boolean"
      },
      "description": {
        "type": "string"
      },
      "address": {
        "type": "string"
      },
      "dao_address": {
        "type": "string",
        "deprecated": true
      },
      "jetton_master_address": {
        "type": "string"
      },
      "initiated_by_address": {
        "type": "string"
      },
      "success_amount": {
        "type": "string"
      },
      "current_amount": {
        "type": "string"
      },
      "total_supply": {
        "type": "string"
      },
      "success_percentage": {
        "type": "number"
      },
      "date_start": {
        "type": "string"
      },
      "date_expire": {
        "type": "string"
      },
      "type": {
        "type": "string"
      },
      "data": {
        "type": "object",
        "additionalProperties": true
      },
      "status": {
        "$ref": "#/components/schemas/ProposalStatus"
      },
      "raw_data": {
        "type": "string"
      },
      "dao": {
        "$ref": "#/components/schemas/Dao"
      }
    }
  },
  "ProposalStatus": {
    "type": "string",
    "enum": [
      "active",
      "rejected",
      "executed",
      "mine",
      "unknown"
    ]
  },
  "Dao": {
    "type": "object",
    "required": [
      "address",
      "owner_address",
      "name",
      "jetton_address",
      "jetton_metadata",
      "success_percentage",
      "total_supply",
      "plugins",
      "date_create",
      "crowdfunding_status"
    ],
    "properties": {
      "address": {
        "type": "string"
      },
      "owner_address": {
        "type": "string"
      },
      "name": {
        "type": "string"
      },
      "jetton_address": {
        "type": "string"
      },
      "jetton_metadata": {
        "type": "object",
        "additionalProperties": true
      },
      "success_percentage": {
        "type": "number"
      },
      "total_supply": {
        "type": "string"
      },
      "date_create": {
        "type": "string"
      },
      "plugins": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/Plugin"
        }
      },
      "crowdfunding_status": {
        "type": "string",
        "enum": [
          "legacy",
          "enabled",
          "ready"
        ]
      }
    }
  },
  "Plugin": {
    "type": "object",
    "required": [
      "address",
      "type"
    ],
    "properties": {
      "address": {
        "type": "string"
      },
      "type": {
        "type": "string"
      },
      "lp_manager_index": {
        "type": "integer",
        "nullable": true,
        "description": "LP Manager index (v6.1+), null for other plugin types."
      },
      "lp_jetton_master_address": {
        "type": "string",
        "nullable": true,
        "description": "LP token jetton master address (only for LP Manager)."
      },
      "lp_token_name": {
        "type": "string",
        "nullable": true
      },
      "lp_token_symbol": {
        "type": "string",
        "nullable": true
      },
      "lp_token_image": {
        "type": "string",
        "nullable": true
      },
      "subaccount_index": {
        "type": "integer",
        "nullable": true
      },
      "subaccount_name": {
        "type": "string",
        "nullable": true
      }
    }
  }
}

Объект CampaignStatus

{
  "CampaignStatus": {
    "type": "string",
    "enum": [
      "active",
      "successful",
      "failed",
      "emergency_withdrawn"
    ]
  }
}

Объект CrowdfundingContributor

{
  "CrowdfundingContributor": {
    "type": "object",
    "required": [
      "address",
      "amount"
    ],
    "properties": {
      "address": {
        "type": "string"
      },
      "amount": {
        "type": "string"
      }
    }
  }
}

Объект CrowdfundingParticipant

{
  "CrowdfundingParticipant": {
    "type": "object",
    "required": [
      "address",
      "masterAddress",
      "ownerAddress",
      "amount"
    ],
    "properties": {
      "address": {
        "type": "string"
      },
      "masterAddress": {
        "type": "string"
      },
      "ownerAddress": {
        "type": "string"
      },
      "amount": {
        "type": "string"
      },
      "isClaimed": {
        "type": "boolean"
      },
      "isRefunded": {
        "type": "boolean"
      },
      "claimedAt": {
        "type": "string",
        "format": "date-time"
      },
      "refundedAt": {
        "type": "string",
        "format": "date-time"
      },
      "dateCreate": {
        "type": "string",
        "format": "date-time"
      }
    }
  }
}

Объект CrowdfundingCampaign

{
  "CrowdfundingCampaign": {
    "type": "object",
    "required": [
      "address",
      "daoAddress",
      "status"
    ],
    "properties": {
      "address": {
        "type": "string"
      },
      "daoAddress": {
        "type": "string"
      },
      "name": {
        "type": "string"
      },
      "description": {
        "type": "string"
      },
      "daoName": {
        "type": "string"
      },
      "isNative": {
        "type": "boolean"
      },
      "jettonSymbol": {
        "type": "string",
        "nullable": true
      },
      "jettonDecimals": {
        "type": "integer",
        "nullable": true
      },
      "jettonImage": {
        "type": "string",
        "nullable": true
      },
      "jettonMasterAddress": {
        "type": "string"
      },
      "lpManagerAddress": {
        "type": "string"
      },
      "lpJettonMasterAddress": {
        "type": "string"
      },
      "destinationAddress": {
        "type": "string"
      },
      "feeManagerAddress": {
        "type": "string"
      },
      "minTotalAmount": {
        "type": "string"
      },
      "maxTotalAmount": {
        "type": "string"
      },
      "minAmountPerUser": {
        "type": "string"
      },
      "maxAmountPerUser": {
        "type": "string"
      },
      "startTime": {
        "type": "string",
        "format": "date-time"
      },
      "endTime": {
        "type": "string",
        "format": "date-time"
      },
      "lpPrice": {
        "type": "string"
      },
      "managementFee": {
        "type": "integer"
      },
      "status": {
        "$ref": "#/components/schemas/CampaignStatus"
      },
      "paused": {
        "type": "boolean"
      },
      "totalAmount": {
        "type": "string"
      },
      "totalClaimed": {
        "type": "string"
      },
      "totalRefunded": {
        "type": "string"
      },
      "isEmergencyWithdrawn": {
        "type": "boolean"
      },
      "hasWhitelist": {
        "type": "boolean"
      },
      "whitelist": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "contributors": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/CrowdfundingContributor"
        }
      },
      "participantsCount": {
        "type": "integer"
      },
      "progressPercentage": {
        "type": "number",
        "format": "float"
      },
      "updatedAt": {
        "type": "string",
        "format": "date-time"
      },
      "finishedAt": {
        "type": "string",
        "format": "date-time"
      },
      "dao": {
        "$ref": "#/components/schemas/Dao"
      },
      "userHelper": {
        "$ref": "#/components/schemas/CrowdfundingParticipant"
      },
      "daoFeeClaimed": {
        "type": "boolean"
      },
      "daoFeeClaimedAt": {
        "type": "string",
        "format": "date-time",
        "nullable": true
      },
      "daoFeeAmount": {
        "type": "string"
      }
    }
  },
  "CampaignStatus": {
    "type": "string",
    "enum": [
      "active",
      "successful",
      "failed",
      "emergency_withdrawn"
    ]
  },
  "CrowdfundingContributor": {
    "type": "object",
    "required": [
      "address",
      "amount"
    ],
    "properties": {
      "address": {
        "type": "string"
      },
      "amount": {
        "type": "string"
      }
    }
  },
  "Dao": {
    "type": "object",
    "required": [
      "address",
      "owner_address",
      "name",
      "jetton_address",
      "jetton_metadata",
      "success_percentage",
      "total_supply",
      "plugins",
      "date_create",
      "crowdfunding_status"
    ],
    "properties": {
      "address": {
        "type": "string"
      },
      "owner_address": {
        "type": "string"
      },
      "name": {
        "type": "string"
      },
      "jetton_address": {
        "type": "string"
      },
      "jetton_metadata": {
        "type": "object",
        "additionalProperties": true
      },
      "success_percentage": {
        "type": "number"
      },
      "total_supply": {
        "type": "string"
      },
      "date_create": {
        "type": "string"
      },
      "plugins": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/Plugin"
        }
      },
      "crowdfunding_status": {
        "type": "string",
        "enum": [
          "legacy",
          "enabled",
          "ready"
        ]
      }
    }
  },
  "Plugin": {
    "type": "object",
    "required": [
      "address",
      "type"
    ],
    "properties": {
      "address": {
        "type": "string"
      },
      "type": {
        "type": "string"
      },
      "lp_manager_index": {
        "type": "integer",
        "nullable": true,
        "description": "LP Manager index (v6.1+), null for other plugin types."
      },
      "lp_jetton_master_address": {
        "type": "string",
        "nullable": true,
        "description": "LP token jetton master address (only for LP Manager)."
      },
      "lp_token_name": {
        "type": "string",
        "nullable": true
      },
      "lp_token_symbol": {
        "type": "string",
        "nullable": true
      },
      "lp_token_image": {
        "type": "string",
        "nullable": true
      },
      "subaccount_index": {
        "type": "integer",
        "nullable": true
      },
      "subaccount_name": {
        "type": "string",
        "nullable": true
      }
    }
  },
  "CrowdfundingParticipant": {
    "type": "object",
    "required": [
      "address",
      "masterAddress",
      "ownerAddress",
      "amount"
    ],
    "properties": {
      "address": {
        "type": "string"
      },
      "masterAddress": {
        "type": "string"
      },
      "ownerAddress": {
        "type": "string"
      },
      "amount": {
        "type": "string"
      },
      "isClaimed": {
        "type": "boolean"
      },
      "isRefunded": {
        "type": "boolean"
      },
      "claimedAt": {
        "type": "string",
        "format": "date-time"
      },
      "refundedAt": {
        "type": "string",
        "format": "date-time"
      },
      "dateCreate": {
        "type": "string",
        "format": "date-time"
      }
    }
  }
}

Объект CrowdfundingLpHolder

{
  "CrowdfundingLpHolder": {
    "type": "object",
    "required": [
      "lpJettonWalletAddress",
      "ownerAddress",
      "balance"
    ],
    "properties": {
      "lpJettonWalletAddress": {
        "type": "string"
      },
      "ownerAddress": {
        "type": "string"
      },
      "balance": {
        "type": "string"
      }
    }
  }
}

Объект DaoLpMasterWithLpHolders

{
  "DaoLpMasterWithLpHolders": {
    "type": "object",
    "required": [
      "lpJettonMasterAddress",
      "campaignAddresses",
      "holdersTotal",
      "holders"
    ],
    "properties": {
      "lpJettonMasterAddress": {
        "type": "string"
      },
      "campaignAddresses": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "holdersTotal": {
        "type": "integer",
        "format": "int64"
      },
      "holders": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/CrowdfundingLpHolder"
        }
      }
    }
  },
  "CrowdfundingLpHolder": {
    "type": "object",
    "required": [
      "lpJettonWalletAddress",
      "ownerAddress",
      "balance"
    ],
    "properties": {
      "lpJettonWalletAddress": {
        "type": "string"
      },
      "ownerAddress": {
        "type": "string"
      },
      "balance": {
        "type": "string"
      }
    }
  }
}

Объект DaoHoldersList

{
  "DaoHoldersList": {
    "type": "object",
    "required": [
      "total",
      "items"
    ],
    "properties": {
      "total": {
        "type": "integer",
        "format": "int64"
      },
      "items": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/Holder"
        }
      }
    }
  },
  "Holder": {
    "type": "object",
    "required": [
      "jetton_wallet_address",
      "owner_address",
      "balance"
    ],
    "properties": {
      "jetton_wallet_address": {
        "type": "string"
      },
      "owner_address": {
        "type": "string"
      },
      "balance": {
        "type": "string"
      }
    }
  }
}

Объект ProposalList

{
  "ProposalList": {
    "type": "object",
    "required": [
      "total",
      "items"
    ],
    "properties": {
      "total": {
        "type": "integer",
        "format": "int64"
      },
      "items": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/Proposal"
        }
      }
    }
  },
  "Proposal": {
    "type": "object",
    "required": [
      "proposal_id",
      "address",
      "dao_address",
      "jetton_master_address",
      "initiated_by_address",
      "success_amount",
      "current_amount",
      "total_supply",
      "success_percentage",
      "date_start",
      "date_expire",
      "type",
      "data",
      "status",
      "raw_data",
      "dao"
    ],
    "properties": {
      "proposal_id": {
        "type": "integer",
        "format": "int64"
      },
      "name": {
        "type": "string"
      },
      "is_user_voted": {
        "type": "boolean"
      },
      "description": {
        "type": "string"
      },
      "address": {
        "type": "string"
      },
      "dao_address": {
        "type": "string",
        "deprecated": true
      },
      "jetton_master_address": {
        "type": "string"
      },
      "initiated_by_address": {
        "type": "string"
      },
      "success_amount": {
        "type": "string"
      },
      "current_amount": {
        "type": "string"
      },
      "total_supply": {
        "type": "string"
      },
      "success_percentage": {
        "type": "number"
      },
      "date_start": {
        "type": "string"
      },
      "date_expire": {
        "type": "string"
      },
      "type": {
        "type": "string"
      },
      "data": {
        "type": "object",
        "additionalProperties": true
      },
      "status": {
        "$ref": "#/components/schemas/ProposalStatus"
      },
      "raw_data": {
        "type": "string"
      },
      "dao": {
        "$ref": "#/components/schemas/Dao"
      }
    }
  },
  "ProposalStatus": {
    "type": "string",
    "enum": [
      "active",
      "rejected",
      "executed",
      "mine",
      "unknown"
    ]
  },
  "Dao": {
    "type": "object",
    "required": [
      "address",
      "owner_address",
      "name",
      "jetton_address",
      "jetton_metadata",
      "success_percentage",
      "total_supply",
      "plugins",
      "date_create",
      "crowdfunding_status"
    ],
    "properties": {
      "address": {
        "type": "string"
      },
      "owner_address": {
        "type": "string"
      },
      "name": {
        "type": "string"
      },
      "jetton_address": {
        "type": "string"
      },
      "jetton_metadata": {
        "type": "object",
        "additionalProperties": true
      },
      "success_percentage": {
        "type": "number"
      },
      "total_supply": {
        "type": "string"
      },
      "date_create": {
        "type": "string"
      },
      "plugins": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/Plugin"
        }
      },
      "crowdfunding_status": {
        "type": "string",
        "enum": [
          "legacy",
          "enabled",
          "ready"
        ]
      }
    }
  },
  "Plugin": {
    "type": "object",
    "required": [
      "address",
      "type"
    ],
    "properties": {
      "address": {
        "type": "string"
      },
      "type": {
        "type": "string"
      },
      "lp_manager_index": {
        "type": "integer",
        "nullable": true,
        "description": "LP Manager index (v6.1+), null for other plugin types."
      },
      "lp_jetton_master_address": {
        "type": "string",
        "nullable": true,
        "description": "LP token jetton master address (only for LP Manager)."
      },
      "lp_token_name": {
        "type": "string",
        "nullable": true
      },
      "lp_token_symbol": {
        "type": "string",
        "nullable": true
      },
      "lp_token_image": {
        "type": "string",
        "nullable": true
      },
      "subaccount_index": {
        "type": "integer",
        "nullable": true
      },
      "subaccount_name": {
        "type": "string",
        "nullable": true
      }
    }
  }
}

Объект ProposalVotesList

{
  "ProposalVotesList": {
    "type": "object",
    "required": [
      "total",
      "items"
    ],
    "properties": {
      "total": {
        "type": "integer",
        "format": "int64"
      },
      "items": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/Vote"
        }
      }
    }
  },
  "Vote": {
    "type": "object",
    "required": [
      "proposal_address",
      "voter_address",
      "amount",
      "date_create"
    ],
    "properties": {
      "proposal_address": {
        "type": "string"
      },
      "voter_address": {
        "type": "string"
      },
      "amount": {
        "type": "string"
      },
      "date_create": {
        "type": "string"
      }
    }
  }
}

Объект CrowdfundingCampaignList

{
  "CrowdfundingCampaignList": {
    "type": "object",
    "required": [
      "total",
      "items"
    ],
    "properties": {
      "total": {
        "type": "integer",
        "format": "int64"
      },
      "items": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/CrowdfundingCampaign"
        }
      }
    }
  },
  "CrowdfundingCampaign": {
    "type": "object",
    "required": [
      "address",
      "daoAddress",
      "status"
    ],
    "properties": {
      "address": {
        "type": "string"
      },
      "daoAddress": {
        "type": "string"
      },
      "name": {
        "type": "string"
      },
      "description": {
        "type": "string"
      },
      "daoName": {
        "type": "string"
      },
      "isNative": {
        "type": "boolean"
      },
      "jettonSymbol": {
        "type": "string",
        "nullable": true
      },
      "jettonDecimals": {
        "type": "integer",
        "nullable": true
      },
      "jettonImage": {
        "type": "string",
        "nullable": true
      },
      "jettonMasterAddress": {
        "type": "string"
      },
      "lpManagerAddress": {
        "type": "string"
      },
      "lpJettonMasterAddress": {
        "type": "string"
      },
      "destinationAddress": {
        "type": "string"
      },
      "feeManagerAddress": {
        "type": "string"
      },
      "minTotalAmount": {
        "type": "string"
      },
      "maxTotalAmount": {
        "type": "string"
      },
      "minAmountPerUser": {
        "type": "string"
      },
      "maxAmountPerUser": {
        "type": "string"
      },
      "startTime": {
        "type": "string",
        "format": "date-time"
      },
      "endTime": {
        "type": "string",
        "format": "date-time"
      },
      "lpPrice": {
        "type": "string"
      },
      "managementFee": {
        "type": "integer"
      },
      "status": {
        "$ref": "#/components/schemas/CampaignStatus"
      },
      "paused": {
        "type": "boolean"
      },
      "totalAmount": {
        "type": "string"
      },
      "totalClaimed": {
        "type": "string"
      },
      "totalRefunded": {
        "type": "string"
      },
      "isEmergencyWithdrawn": {
        "type": "boolean"
      },
      "hasWhitelist": {
        "type": "boolean"
      },
      "whitelist": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "contributors": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/CrowdfundingContributor"
        }
      },
      "participantsCount": {
        "type": "integer"
      },
      "progressPercentage": {
        "type": "number",
        "format": "float"
      },
      "updatedAt": {
        "type": "string",
        "format": "date-time"
      },
      "finishedAt": {
        "type": "string",
        "format": "date-time"
      },
      "dao": {
        "$ref": "#/components/schemas/Dao"
      },
      "userHelper": {
        "$ref": "#/components/schemas/CrowdfundingParticipant"
      },
      "daoFeeClaimed": {
        "type": "boolean"
      },
      "daoFeeClaimedAt": {
        "type": "string",
        "format": "date-time",
        "nullable": true
      },
      "daoFeeAmount": {
        "type": "string"
      }
    }
  },
  "CampaignStatus": {
    "type": "string",
    "enum": [
      "active",
      "successful",
      "failed",
      "emergency_withdrawn"
    ]
  },
  "CrowdfundingContributor": {
    "type": "object",
    "required": [
      "address",
      "amount"
    ],
    "properties": {
      "address": {
        "type": "string"
      },
      "amount": {
        "type": "string"
      }
    }
  },
  "Dao": {
    "type": "object",
    "required": [
      "address",
      "owner_address",
      "name",
      "jetton_address",
      "jetton_metadata",
      "success_percentage",
      "total_supply",
      "plugins",
      "date_create",
      "crowdfunding_status"
    ],
    "properties": {
      "address": {
        "type": "string"
      },
      "owner_address": {
        "type": "string"
      },
      "name": {
        "type": "string"
      },
      "jetton_address": {
        "type": "string"
      },
      "jetton_metadata": {
        "type": "object",
        "additionalProperties": true
      },
      "success_percentage": {
        "type": "number"
      },
      "total_supply": {
        "type": "string"
      },
      "date_create": {
        "type": "string"
      },
      "plugins": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/Plugin"
        }
      },
      "crowdfunding_status": {
        "type": "string",
        "enum": [
          "legacy",
          "enabled",
          "ready"
        ]
      }
    }
  },
  "Plugin": {
    "type": "object",
    "required": [
      "address",
      "type"
    ],
    "properties": {
      "address": {
        "type": "string"
      },
      "type": {
        "type": "string"
      },
      "lp_manager_index": {
        "type": "integer",
        "nullable": true,
        "description": "LP Manager index (v6.1+), null for other plugin types."
      },
      "lp_jetton_master_address": {
        "type": "string",
        "nullable": true,
        "description": "LP token jetton master address (only for LP Manager)."
      },
      "lp_token_name": {
        "type": "string",
        "nullable": true
      },
      "lp_token_symbol": {
        "type": "string",
        "nullable": true
      },
      "lp_token_image": {
        "type": "string",
        "nullable": true
      },
      "subaccount_index": {
        "type": "integer",
        "nullable": true
      },
      "subaccount_name": {
        "type": "string",
        "nullable": true
      }
    }
  },
  "CrowdfundingParticipant": {
    "type": "object",
    "required": [
      "address",
      "masterAddress",
      "ownerAddress",
      "amount"
    ],
    "properties": {
      "address": {
        "type": "string"
      },
      "masterAddress": {
        "type": "string"
      },
      "ownerAddress": {
        "type": "string"
      },
      "amount": {
        "type": "string"
      },
      "isClaimed": {
        "type": "boolean"
      },
      "isRefunded": {
        "type": "boolean"
      },
      "claimedAt": {
        "type": "string",
        "format": "date-time"
      },
      "refundedAt": {
        "type": "string",
        "format": "date-time"
      },
      "dateCreate": {
        "type": "string",
        "format": "date-time"
      }
    }
  }
}

Объект DaoLpMasterWithLpHoldersList

{
  "DaoLpMasterWithLpHoldersList": {
    "type": "object",
    "required": [
      "total",
      "items"
    ],
    "properties": {
      "total": {
        "type": "integer",
        "format": "int64"
      },
      "items": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/DaoLpMasterWithLpHolders"
        }
      }
    }
  },
  "DaoLpMasterWithLpHolders": {
    "type": "object",
    "required": [
      "lpJettonMasterAddress",
      "campaignAddresses",
      "holdersTotal",
      "holders"
    ],
    "properties": {
      "lpJettonMasterAddress": {
        "type": "string"
      },
      "campaignAddresses": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "holdersTotal": {
        "type": "integer",
        "format": "int64"
      },
      "holders": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/CrowdfundingLpHolder"
        }
      }
    }
  },
  "CrowdfundingLpHolder": {
    "type": "object",
    "required": [
      "lpJettonWalletAddress",
      "ownerAddress",
      "balance"
    ],
    "properties": {
      "lpJettonWalletAddress": {
        "type": "string"
      },
      "ownerAddress": {
        "type": "string"
      },
      "balance": {
        "type": "string"
      }
    }
  }
}
{
  "ContributionLink": {
    "type": "object",
    "required": [
      "isNative",
      "campaignAddress",
      "tonTransfer",
      "details",
      "warnings"
    ],
    "properties": {
      "isNative": {
        "type": "boolean",
        "description": "`true` for native TON campaigns, `false` for jetton campaigns."
      },
      "campaignAddress": {
        "type": "string",
        "description": "Address that the `ton://transfer/` URI sends the message to (bounceable\nmainnet form). For jetton campaigns this is the *investor's* jetton\nwallet, **not** the campaign master.\n"
      },
      "tonTransfer": {
        "type": "object",
        "required": [
          "uri"
        ],
        "properties": {
          "uri": {
            "type": "string",
            "description": "Ready-to-sign `ton://transfer/{to}?amount={nanoton}&bin={base64url}`\nURI. Open it in a TON wallet (Tonkeeper et al.) to sign — no further\nmanipulation should be necessary.\n"
          }
        }
      },
      "details": {
        "type": "object",
        "description": "Same payload as `tonTransfer.uri`, but pre-decoded for clients that\nprefer to construct the transaction themselves (e.g. TonConnect).\n",
        "required": [
          "to",
          "valueNanoton",
          "bodyBocBase64Url"
        ],
        "properties": {
          "to": {
            "type": "string",
            "description": "Destination address (bounceable mainnet)."
          },
          "valueNanoton": {
            "type": "string",
            "description": "Message value in nanoTON as a decimal string."
          },
          "bodyBocBase64Url": {
            "type": "string",
            "description": "Message body BoC, base64url-encoded (no padding)."
          }
        }
      },
      "miniAppLink": {
        "type": "string",
        "description": "Optional Telegram Mini-App deeplink that opens this campaign in the\nXDAO bot — bonus convenience for integrators.\n"
      },
      "warnings": {
        "type": "array",
        "description": "Non-fatal signals. The transaction is still served. Known values:\n- `whitelist_enforced_on_chain` — campaign has a whitelist; on-chain\n  `throw` will reject contributors not on it.\n- `amount_exceeds_remaining_hardcap` — `amount > hardCap - totalAmount`.\n",
        "items": {
          "type": "string"
        }
      }
    }
  }
}
{
  "ClaimLink": {
    "type": "object",
    "description": "Ready-to-sign deeplink for an LP claim. \n",
    "required": [
      "kind",
      "campaignAddress",
      "tonTransfer",
      "details",
      "warnings"
    ],
    "properties": {
      "kind": {
        "type": "string",
        "description": "Which claim this link performs.",
        "enum": [
          "initial",
          "vesting"
        ]
      },
      "campaignAddress": {
        "type": "string",
        "description": "Bounceable mainnet form of the crowdfunding master address."
      },
      "tonTransfer": {
        "type": "object",
        "required": [
          "uri"
        ],
        "properties": {
          "uri": {
            "type": "string",
            "description": "Ready-to-sign `ton://transfer/{to}?amount={nanoton}&bin={base64url}`\nURI. For `kind=initial` `to` is the Helper; for `kind=vesting` the\nVestingVault.\n"
          }
        }
      },
      "details": {
        "type": "object",
        "description": "Same payload as `tonTransfer.uri`, pre-decoded for clients that prefer\nto construct the transaction themselves (e.g. TonConnect).\n",
        "required": [
          "to",
          "valueNanoton",
          "bodyBocBase64Url"
        ],
        "properties": {
          "to": {
            "type": "string",
            "description": "Destination address (bounceable mainnet) — Helper or VestingVault."
          },
          "valueNanoton": {
            "type": "string",
            "description": "Message value in nanoTON as a decimal string."
          },
          "bodyBocBase64Url": {
            "type": "string",
            "description": "Message body BoC, base64url-encoded (no padding)."
          }
        }
      },
      "vesting": {
        "type": "object",
        "description": "Present only for `kind=vesting`. An **estimate** of the claimable LP and\nthe current vesting phase; the exact amount is computed on-chain by the\nvault at execution time.\n",
        "required": [
          "phase",
          "claimableAmount",
          "vestedAmount",
          "totalLpAmount",
          "claimedLpAmount"
        ],
        "properties": {
          "phase": {
            "type": "string",
            "description": "Vesting phase at the time of the request.",
            "enum": [
              "not_started",
              "cliff",
              "vesting",
              "fully_vested",
              "emergency"
            ]
          },
          "claimableAmount": {
            "type": "string",
            "description": "Estimated claimable LP (vested minus already claimed), smallest units."
          },
          "vestedAmount": {
            "type": "string",
            "description": "Estimated total vested LP so far, smallest units."
          },
          "totalLpAmount": {
            "type": "string",
            "description": "Total LP allocated to the investor, smallest units."
          },
          "claimedLpAmount": {
            "type": "string",
            "description": "LP already claimed, smallest units."
          },
          "vestingEnd": {
            "type": "string",
            "format": "date-time",
            "description": "Computed end = vestingStart + vestingDuration."
          }
        }
      },
      "warnings": {
        "type": "array",
        "description": "Non-fatal signals. The transaction is still served. Known values:\n- `nothing_claimable_now` — estimated claimable amount is 0 (e.g. before\n  TGE or between linear ticks). Signing it will fail the vault's\n  `nothing_to_claim` guard.\n",
        "items": {
          "type": "string"
        }
      }
    }
  }
}

Объект ParticipantVesting

{
  "ParticipantVesting": {
    "type": "object",
    "required": [
      "vaultAddress",
      "totalLpAmount",
      "claimedLpAmount",
      "isInitialized",
      "isEmergencyReleased"
    ],
    "properties": {
      "vaultAddress": {
        "type": "string"
      },
      "totalLpAmount": {
        "type": "string",
        "description": "Total LP locked into the vesting vault."
      },
      "claimedLpAmount": {
        "type": "string",
        "description": "LP already claimed out of the vesting vault."
      },
      "vestingStart": {
        "type": "string",
        "format": "date-time"
      },
      "cliffDuration": {
        "type": "integer",
        "description": "Cliff duration in seconds."
      },
      "vestingDuration": {
        "type": "integer",
        "description": "Linear vesting duration in seconds."
      },
      "tgeUnlockBps": {
        "type": "integer",
        "description": "TGE unlock in basis points (1/100 of a percent)."
      },
      "vestingEnd": {
        "type": "string",
        "format": "date-time",
        "description": "Computed end = vestingStart + cliffDuration + vestingDuration."
      },
      "isInitialized": {
        "type": "boolean"
      },
      "isEmergencyReleased": {
        "type": "boolean"
      }
    }
  }
}

Объект DaoParticipantCampaign

{
  "DaoParticipantCampaign": {
    "type": "object",
    "required": [
      "campaignAddress",
      "helperAddress",
      "amount",
      "lpBalance",
      "isClaimed",
      "isRefunded"
    ],
    "properties": {
      "campaignAddress": {
        "type": "string",
        "description": "Crowdfunding master address."
      },
      "helperAddress": {
        "type": "string",
        "description": "Per-user helper contract address."
      },
      "campaignName": {
        "type": "string"
      },
      "isNative": {
        "type": "boolean",
        "description": "True for native TON campaigns, false for jetton campaigns."
      },
      "jettonSymbol": {
        "type": "string",
        "description": "Collection-currency jetton symbol (jetton campaigns)."
      },
      "amount": {
        "type": "string",
        "description": "Invested amount in collection currency."
      },
      "lpBalance": {
        "type": "string",
        "description": "LP held in the wallet for this campaign (0 if none)."
      },
      "isClaimed": {
        "type": "boolean"
      },
      "isRefunded": {
        "type": "boolean"
      },
      "claimedAt": {
        "type": "string",
        "format": "date-time"
      },
      "refundedAt": {
        "type": "string",
        "format": "date-time"
      },
      "dateCreate": {
        "type": "string",
        "format": "date-time"
      },
      "vesting": {
        "$ref": "#/components/schemas/ParticipantVesting"
      }
    }
  },
  "ParticipantVesting": {
    "type": "object",
    "required": [
      "vaultAddress",
      "totalLpAmount",
      "claimedLpAmount",
      "isInitialized",
      "isEmergencyReleased"
    ],
    "properties": {
      "vaultAddress": {
        "type": "string"
      },
      "totalLpAmount": {
        "type": "string",
        "description": "Total LP locked into the vesting vault."
      },
      "claimedLpAmount": {
        "type": "string",
        "description": "LP already claimed out of the vesting vault."
      },
      "vestingStart": {
        "type": "string",
        "format": "date-time"
      },
      "cliffDuration": {
        "type": "integer",
        "description": "Cliff duration in seconds."
      },
      "vestingDuration": {
        "type": "integer",
        "description": "Linear vesting duration in seconds."
      },
      "tgeUnlockBps": {
        "type": "integer",
        "description": "TGE unlock in basis points (1/100 of a percent)."
      },
      "vestingEnd": {
        "type": "string",
        "format": "date-time",
        "description": "Computed end = vestingStart + cliffDuration + vestingDuration."
      },
      "isInitialized": {
        "type": "boolean"
      },
      "isEmergencyReleased": {
        "type": "boolean"
      }
    }
  }
}

Объект DaoParticipantStatus

{
  "DaoParticipantStatus": {
    "type": "object",
    "required": [
      "daoAddress",
      "ownerAddress",
      "campaigns",
      "totalInvested",
      "totalLpHeld",
      "totalLpVesting",
      "activeCount"
    ],
    "properties": {
      "daoAddress": {
        "type": "string"
      },
      "ownerAddress": {
        "type": "string"
      },
      "campaigns": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/DaoParticipantCampaign"
        }
      },
      "totalInvested": {
        "type": "string",
        "description": "Sum of invested amounts across this DAO's campaigns."
      },
      "totalLpHeld": {
        "type": "string",
        "description": "Sum of LP held in the wallet across this DAO's campaigns."
      },
      "totalLpVesting": {
        "type": "string",
        "description": "Sum of LP still locked in vesting vaults."
      },
      "activeCount": {
        "type": "integer",
        "description": "Campaigns not yet claimed nor refunded."
      }
    }
  },
  "DaoParticipantCampaign": {
    "type": "object",
    "required": [
      "campaignAddress",
      "helperAddress",
      "amount",
      "lpBalance",
      "isClaimed",
      "isRefunded"
    ],
    "properties": {
      "campaignAddress": {
        "type": "string",
        "description": "Crowdfunding master address."
      },
      "helperAddress": {
        "type": "string",
        "description": "Per-user helper contract address."
      },
      "campaignName": {
        "type": "string"
      },
      "isNative": {
        "type": "boolean",
        "description": "True for native TON campaigns, false for jetton campaigns."
      },
      "jettonSymbol": {
        "type": "string",
        "description": "Collection-currency jetton symbol (jetton campaigns)."
      },
      "amount": {
        "type": "string",
        "description": "Invested amount in collection currency."
      },
      "lpBalance": {
        "type": "string",
        "description": "LP held in the wallet for this campaign (0 if none)."
      },
      "isClaimed": {
        "type": "boolean"
      },
      "isRefunded": {
        "type": "boolean"
      },
      "claimedAt": {
        "type": "string",
        "format": "date-time"
      },
      "refundedAt": {
        "type": "string",
        "format": "date-time"
      },
      "dateCreate": {
        "type": "string",
        "format": "date-time"
      },
      "vesting": {
        "$ref": "#/components/schemas/ParticipantVesting"
      }
    }
  },
  "ParticipantVesting": {
    "type": "object",
    "required": [
      "vaultAddress",
      "totalLpAmount",
      "claimedLpAmount",
      "isInitialized",
      "isEmergencyReleased"
    ],
    "properties": {
      "vaultAddress": {
        "type": "string"
      },
      "totalLpAmount": {
        "type": "string",
        "description": "Total LP locked into the vesting vault."
      },
      "claimedLpAmount": {
        "type": "string",
        "description": "LP already claimed out of the vesting vault."
      },
      "vestingStart": {
        "type": "string",
        "format": "date-time"
      },
      "cliffDuration": {
        "type": "integer",
        "description": "Cliff duration in seconds."
      },
      "vestingDuration": {
        "type": "integer",
        "description": "Linear vesting duration in seconds."
      },
      "tgeUnlockBps": {
        "type": "integer",
        "description": "TGE unlock in basis points (1/100 of a percent)."
      },
      "vestingEnd": {
        "type": "string",
        "format": "date-time",
        "description": "Computed end = vestingStart + cliffDuration + vestingDuration."
      },
      "isInitialized": {
        "type": "boolean"
      },
      "isEmergencyReleased": {
        "type": "boolean"
      }
    }
  }
}

Объект Error

{
  "Error": {
    "type": "object",
    "required": [
      "error"
    ],
    "properties": {
      "error": {
        "type": "string"
      }
    }
  }
}

On this page