ProfileSwap
AccountProfileSwap contains swap settings per symbol which apply charges on positions held overnight. All such settings are defined in AccountProfileSwapSetting. AccountProfileSwap has the following attributes and can be accessed via pending config or real-time config:
| attributes | required | default settings | attribute type | description |
|---|---|---|---|---|
| id | Y | – | INT | The ID of the profile; generated. |
| name | Y | – | STRING | The name of the profile |
| description | N | n/a | STRING | Free text |
AccountProfileSwapSetting
AccountProfileSwapSetting defines swap settings per symbol. AccountProfileSwapSetting has the below attributes:
| attributes | required | default settings | attribute type | description |
|---|---|---|---|---|
| profile | Y | – | INT | The name of the profile |
| symbol | Y | – | STRING | A known symbol name or * fallback. An explicit symbol setting takes precedence over the fallback. Supply matching rates for every symbol that should receive swaps. |
| type | Y | POINTS | STRING | The swap type: POINTS or PERCENTAGE. POINTS: a signed quote-currency amount per base-position unit; signed position base size × the selected long/short value gives the raw swap in quote currency. PERCENTAGE: uses a 360-day rate convention. For FX, signed base position × selected annual percentage / 100 / 360 gives the amount in base currency before settlement conversion. For non-FX instruments, −(signed net quote position) × selected annual percentage / 100 / 360 gives the amount in quote currency; the long rate applies while the net quote position is negative and the short rate while it is positive. Accumulated quote P&L can affect both the amount and the selected rate. Some deployments are configured to use the FX convention for non-FX instruments as well; confirm with PrimeXM support if unsure. |
| long | N | 0 | DOUBLE | The rate for a long position: for POINTS a quote-currency amount per unit of base position, for PERCENTAGE an annual percentage (see type); applied at each settlement.- Negative decimal values on long position swaps will result in reducing the balance of the Account - Positive decimal values on long position swaps will result in increasing the balance of the Account |
| short | N | 0 | DOUBLE | The rate for a short position: for POINTS a quote-currency amount per unit of base position, for PERCENTAGE an annual percentage (see type); applied at each settlement.- Positive decimal values on short position swaps will result in reducing the balance of the Account - Negative decimal values on short position swaps will result in increasing the balance of the Account |
| markup | Y | 0 | DOUBLE | A percentage applied after the swap multiplier: it reduces a swap credit and increases a swap debit by this percentage. The markup is included in the swap amount and does not create a separate booking. Allowed values: 0 or greater; no upper bound is enforced. |
| comment | – | – | VARCHAR | Free text for the comment of the swap booking. The following tokens are replaced when the swap is charged: - #SYM# – symbol name- #POINT# – the long or short value that was applied, in either swap mode- #CONV# – conversion rate to the currency of the payment- #%# – the markup percentage appliedExample: the template swap: #SYM#|#POINT#|#CONV# produces a comment such as swap: EURUSD|-0.35|1.0852 in the account report. The tokens are optional and can be combined with any wording. |
| Comment 2 | – | – | VARCHAR(64) | A second comment template supporting the same tokens as comment. |
The configured swap amount is applied at every swap settlement occurrence. A shorter interval does not automatically prorate the amount or annual percentage. Check the settlement interval and swap multiplier together when setting rates.