DSSR allowances by location post code
get_allowances_by_postcodeReturns DSSR allowances (COLA, hardship, LQA, danger pay, education, per diem) for the post identified by
its five-digit DSSR post code, today or on date. Post codes are the State Department's own identifiers
and come back in every DSSR result, so this is the most precise lookup. Use get_allowances_by_location
for a name, get_allowances for the whole country.
Posts the State Department removed return no allowances after their last listing. History starts on 2008-01-01.
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": {
"postcode": "<postcode>",
"country_iso_code": "<country_iso_code>"
},
"name": "get_allowances_by_postcode"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| date | No | The day the rates must be in force, YYYY-MM-DD, from 2008-01-01 on; today when omitted. Plan limits: Sandbox and Google add-on accounts may query dates within 30 days of today, Pro the current and previous US fiscal year, Business any date. | |
| type | No | Filter returned allowances. Unknown values are ignored.<br/>If not specified, all allowances are returned.<br/>Canonical values: cola, hardship, lqa, danger_pay, education, perdiem.<br/>Aliases accepted: cost_of_living, cost-of-living, danger, danger-pay, livingquarters. | |
| postcode | Yes | 5-digit DSSR post code (no zero-padding) | |
| country_iso_code | Yes | ISO 3166-1 alpha-2 country code, e.g. PG for Papua New Guinea; ZZ stands for 'Other Foreign Localities', not a country. Resolve a country name to its code with get_countries (q=name). | |
| verification_url | No | Included by default: a link to the official government table for the returned location and date, for the user to confirm the figures. Pass false to omit it. |