Pair Rate Differentials
rate_differentialsRead-only
Return the stored or derived rate differential for one FX pair, with the measure, rate type, curve family, and tenor metadata that define it. Access: API key required, else returns subscription_required with a subscribe link.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"base": "<base>",
"quote": "<quote>"
},
"name": "rate_differentials"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| base | Yes | Base currency code. | |
| limit | No | Maximum rows to return. | |
| quote | Yes | Quote currency code. | |
| offset | No | Zero-based row offset. | |
| measure | No | Shared rate measure to compare across the pair. | auto |
| end_date | No | Optional inclusive end date, YYYY-MM-DD. | |
| rate_type | No | Differential type. | spot |
| start_date | No | Optional inclusive start date, YYYY-MM-DD. | |
| curve_family | No | Curve family when rate_type is forward. | government_nominal |
| end_tenor_years | No | End tenor in years for forward differentials. | |
| start_tenor_years | No | Start tenor in years for forward differentials. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |