create_rate_alert
Set up rate alerts to be notified when the exchange rate hits your target, with optional automatic trade execution.
Instructions
Creates a rate alert. When the market rate reaches target_rate, you are notified. If book=true the trade is automatically booked.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sell_currency | Yes | 3-letter currency code the client has (e.g. EUR) | |
| buy_currency | Yes | 3-letter currency code the client wants (e.g. USD) | |
| side | Yes | ||
| amount | Yes | Amount in the side currency | |
| target_rate | Yes | The exchange rate that triggers the alert | |
| book | No | If true, automatically book a trade when target rate is reached (default: false) | |
| reason | No | Required if book=true. Transfer reason. | |
| delivery_date | No | Fixed delivery date in YYYY-MM-DD format (useful for forward contracts) | |
| expiration_date | No | Alert expiry date in YYYY-MM-DD format (max 30 days; defaults to max) | |
| note | No | Optional note to attach to the alert | |
| broker_code | No | Restrict auto-booking to a specific broker |