get_deal
Retrieve a single deal by MongoDB ObjectId or UUID, with field presets from minimal to full.
Instructions
Get a single deal by its MongoDB ObjectId. Supports the same field selection presets as list_deals.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| dealType | Yes | Deal type | |
| dealId | Yes | Deal identifier. Accepts EITHER the deal's 24-character hex MongoDB ObjectId (e.g. "65f000000000000000000001") OR the deal's UUID. Either form resolves to the same deal — use whichever the deal record exposes. Get both from list_deals (the `_id` and `uuid` fields). | |
| fields | No | Field selection: preset ("minimal", "standard", "extended", "full") or comma-separated fields (e.g. "_id,uuid,settings.name,profit.total"). Default: "standard" | |
| paperContext | No | Paper trading context (true = paper, false = real). Default: false |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| status | No | OK on success, NOTOK on a handled API error. | |
| reason | No | Error reason when status is NOTOK; null otherwise. | |
| data | No | The deal record; fields present depend on the `fields` preset. | |
| meta | No | Pagination / result metadata, present on list-style responses. |