Allowances API

Calculate mileage reimbursement with the official GSA rate in effect on the travel date (today if omitted). Provide a distance in miles and the vehicle type: automobile, airplane, motorcycle or moving. For automobile travel, say whether a government-furnished automobile was available, which selects the reduced rate. Returns the rate category, rate and effective date, and the amount rounded to the cent. Use get_mileage for the rates alone.

Estimates GSA CONUS per diem for a multi-stop trip: a day-by-day breakdown and totals of payable lodging and M&IE. Each stop has inclusive arrival and departure dates and a GSA destination ID or ZIP code, optionally the actual nightly lodging cost and meals to deduct. Applies the rate in effect each day, 75% M&IE on first and last days, the official meal deductions and the lodging cap (excess reported as overage). Not for Department of Defense or foreign travel.

Calculates the DSSR cost-of-living allowance (COLA) for a post: the COLA rate in percent and the annual and biweekly USD amounts for the given base salary and family size, today or on `date`. The post is identified by its five-digit DSSR post code (see get_dssr_locations_by_country). Use get_allowances for the COLA rate alone.

Returns State Department (DSSR) allowance rates for every post in a country: cost-of-living (COLA), hardship differential, living quarters (LQA), danger pay and education allowances, plus each post's per diem, in force today or on `date`. `type` limits the result to some allowances. For one post use get_allowances_by_location or get_allowances_by_postcode; for Department of Defense rates use the DTMO tools.

Returns DSSR allowances (COLA, hardship, LQA, danger pay, education, per diem) for one post in a country matched by name, case-insensitive and partial ('toky' finds Tokyo), today or on `date`. Find exact post names with get_dssr_locations_by_country or search_perdiem. Use get_allowances_by_postcode when the DSSR post code is known, get_allowances for every post in the country.

Returns 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.

Returns the airport or metropolitan codes GSA uses in City Pair airfare awards for the fiscal year of `date` (today by default), with city, state and country. GSA decides whether a city uses airport codes (DCA, IAD) or a metro code (WAS), so resolve codes here before get_city_pairs. `q` (3+ characters) matches a code exactly or a city or country name by substring. Fiscal years other than the current one depend on the plan.

Returns GSA City Pair Program contract airfares between two codes (see get_city_pair_locations) on `date`, today by default: every matching award with airline, service and one-way USD fares by category (YCA, CA, business and others; null means not offered), valid in either direction. Government contract prices, not live availability; domestic fares exclude passenger and security fees. Other fiscal years depend on the plan; there is no fallback to another date.

Resolves a country name to its ISO alpha-2 code and lists the names of its DSSR posts; `q` matches the country name case-insensitively ('papua' finds PG). Use it before any tool that needs a country code. ZZ stands for Other Foreign Localities, not a country. Returns no rates.

Returns one country by ISO alpha-2 code: its name, the names of its DSSR posts and State Department notes. Use get_countries to find the code from a name, and get_dssr_locations_by_country when the post codes are needed too. Returns no rates.

Returns the metadata of one GSA destination rate area by numeric ID: GSA's display name, the defined geographic scope, county and state. ID 0 is the Standard CONUS area. No rates: use get_gsa_perdiem_by_destination for the rate on a date and get_destinations to browse IDs.

Returns the paginated list of every GSA destination rate area with its numeric ID, display name, defined scope, county and state, ordered by ID (`offset`, `limit`; past the end is an empty list). Use the ID with get_gsa_perdiem_by_destination or calculate_trip_per_diem. No rates; a ZIP or state lookup is usually faster than browsing.

Returns a paginated list of every DSSR post with its country, ISO code and post name; `q` filters by case-insensitive substring. `total` counts every match regardless of `offset` and `limit`. Use it to find the exact post name for the by-location tools when the country is unknown; get_dssr_locations_by_country is shorter when it is known. Returns no rates.

Returns the DSSR posts of a country by ISO alpha-2 code, each with its name and five-digit post code (`external_id`), as needed by the by-location and by-postcode tools. Use get_countries to resolve a name to the code. Returns no rates.

Returns the DTMO per diem locations of a US state (US-XX code) with location name and county, as named in the Department of Defense CONUS table. Use it to find the name for the `q` filter of get_dtmo_perdiem_conus. Returns no rates. For other countries, Alaska, Hawaii and territories use get_dtmo_oconus_locations.

Returns the DTMO per diem locations of a country by ISO alpha-2 code ('AU', 'BE'), as named in the Department of Defense OCONUS table. `location` filters by case-insensitive substring, taken literally (no wildcards); no match returns an empty list. Use the names for the `q` filter of get_dtmo_perdiem_oconus. Returns no rates.

Department of Defense per diem for the continental U.S. by state code (e.g. 'TX'); Alaska, Hawaii and the territories are served by the OCONUS endpoint. Returns lodging, local and proportional meal rates, incidentals and the maximum per diem (lodging + meals + incidentals) per season. `q` filters by location name. `date` selects the rates in force on that day, `year` a fiscal year (Oct 1 to Sep 30); omit both for the current fiscal year.

Department of Defense per diem outside the continental U.S.: foreign countries by ISO alpha-2 code (e.g. 'PG'), and Alaska, Hawaii and U.S. territories by 'US-XX' code. Returns lodging, local and proportional meal rates, incidentals and the maximum per diem (lodging + meals + incidentals) per season. `q` filters by location name. `date` selects the rates in force on that day, `year` a fiscal year (Oct 1 to Sep 30); omit both for the current fiscal year.

Returns one property on FEMA's Hotel and Motel National Master List by FEMA ID, or a 404 error when the ID is not listed: name, address, phone, property type, stories and sprinklers, with `as_of` the date of the list snapshot. Use it to confirm a hotel is fire-safe for reimbursed federal lodging. No rates.

Returns the properties on FEMA's Hotel and Motel National Master List in a US state, optionally narrowed by a partial, case-insensitive `city` ('york' matches New York and Yorktown), ordered by city then name and paginated with `offset`, `limit` (up to 200) and `total`. Covers the 50 states, DC and the territories FEMA lists. Returns FEMA ID, address and property details, no rates.

Returns every property on FEMA's Hotel and Motel National Master List in a US ZIP code (five digits or ZIP+4), ordered by name, with FEMA ID, address and property details. A known ZIP with no listed property returns an empty list, an unknown ZIP a 404 error. Fire-safe lodging is required for reimbursed federal travel; no rates, pair with get_gsa_perdiem_by_zipcode.

Returns the GSA Fleet vehicle leasing rates (monthly lease rate and rate per mile) for the vehicle type identified by its Standard Item Number (SIN), from the standard (US) or europe rate schedule, for the current fiscal year unless `year` is given; rates are available from fiscal year 2022. SINs are the vehicle-type codes of the GSA Fleet rate schedule; the response names the vehicle type.

Lists current worldwide FedRooms hotels with name, address, postal city, state, postal code and country. Optional q matches every word as a case-insensitive literal substring across those fields. country filters by ISO alpha-2 code; results include country_iso_code. Paginate with offset and limit (maximum 200); total counts matches. as_of is the UTC download date. verification_url always links to GSA. No prices or availability; book through approved channels for the FedRooms rate.

Returns the GSA per diem of one GSA destination rate area (a city, county, metro area or the Standard CONUS area, ID 0) in effect today or on `date`: the seasonal lodging rate and daily M&IE in USD. Destination IDs come from get_destinations or any GSA per diem result. When the ID is unknown use get_gsa_perdiem_by_zipcode or get_gsa_perdiem_by_state.

Returns every GSA destination rate in a US state (US-XX) in effect today or on `date`: seasonal lodging and daily M&IE in USD per destination, with its county. `location` filters by destination or defined-area name, case-insensitive and partial. A state with no non-standard destination returns the Standard CONUS rate. CONUS only: for Alaska, Hawaii, territories and abroad use the DTMO or DSSR tools.

Return every GSA destination rate in a US state (US-XX) for a US fiscal year (October 1 to September 30): the lodging rate for every month and the daily M&IE rate per destination. The optional `location` filters destinations by GSA destination or defined-area name, case-insensitive and partial. Set `verification_url=true` to include the official GSA state lookup URL. Use get_gsa_perdiem_by_state for the rate on one date.

Returns the GSA per diem for a US ZIP code (five digits or ZIP+4) in effect today or on `date`: seasonal lodging and daily M&IE in USD. A ZIP can map to several destinations; then every rate is returned with its county and none is chosen for you. A ZIP with no non-standard destination returns the Standard CONUS rate. Use get_gsa_perdiem_by_zipcode_year for a whole fiscal year.

Returns the GSA lodging rate for every month of a US fiscal year (October 1 to September 30) and the daily M&IE, in USD, for a US ZIP code (five digits or ZIP+4). A ZIP can map to several destinations; then every rate is returned with its county and none is chosen for you. A ZIP with no non-standard destination returns the Standard CONUS rate. Use get_gsa_perdiem_by_zipcode for the rate on one date.

Returns the most recent data loaded for each source, with its publication date and fiscal year: DSSR allowances and per diem, DTMO CONUS and OCONUS per diem, GSA per diem, mileage, vehicle rates and M&IE breakdowns, FEMA hotels and OPM pay tables. Use it to say how current an answer is. Returns no rates.

Return how daily M&IE totals break down into breakfast, lunch, dinner and incidental expenses, as in effect on the given date. The CONUS table breaks down the five standard CONUS M&IE tiers and is returned by default. Set region=oconus for the generic DTMO/DSSR M&IE total table. If date is not specified, today's breakdowns will be returned.

Returns the GSA privately owned vehicle (POV) mileage reimbursement rates in USD per mile for airplane, automobile, government-furnished automobile, motorcycle and moving, in effect today or on `date`; `type` selects one. Use calculate_mileage_reimbursement to turn a distance into an amount.

Returns OPM General Schedule locality pay areas for the latest pay year with the code for get_opm_pay. `location` keeps areas whose name contains every word and areas of counties or cities with exactly that name (`state` narrows it); `matched_places` shows why. A place in no area returns Rest of U.S. (RUS); several areas come back when a name exists in several states or a city spans areas. Empty results mean an unknown name, not RUS. Territories are not covered.

Returns the General Schedule locality pay area of a county by five-digit FIPS code for the latest pay year, with the code for get_opm_pay. Counties outside every area return Rest of U.S. (RUS); every county in Alaska or Hawaii returns that state's area. Unknown codes, Connecticut planning regions and territory counties are 404 errors. Use get_opm_localities to search by name.

Return the latest pay table of a locality pay area, ordered by grade and step, or 404 for an unknown code. `grade` and `step` narrow the rates. Use `GS` for the base table without locality pay, and `RUS` for Rest of U.S.

Returns State Department (DSSR) per diem for every post in a country: lodging, M&IE and maximum per diem in USD per day, today or on `date`. For one post use get_perdiem_allowance_by_location or get_perdiem_allowance_by_postcode; for a place name without a country code use search_perdiem. For Department of Defense travel use get_dtmo_perdiem_oconus.

Returns DSSR per diem (lodging, M&IE and maximum per diem in USD per day) for one post in a country matched by name, case-insensitive and partial, today or on `date`. Find exact post names with get_dssr_locations_by_country or search_perdiem. Use get_perdiem_allowance for the whole country, get_perdiem_allowance_by_postcode for a known post code.

Returns DSSR per diem (lodging, M&IE and maximum per diem in USD per day) for the post identified by its five-digit DSSR post code, today or on `date`. Every DSSR result carries the post code, so use it for follow-up lookups. Use get_perdiem_allowance_by_location for a name, get_perdiem_allowance for the whole country.

Returns the account behind the API key: plan, monthly request limit, requests used in the current billing period, and the period start, end and renewal date. Use it to explain a quota or plan error or to check remaining requests. This call does not count against the quota.

Returns the state or states a US ZIP code (five digits or ZIP+4) belongs to; a ZIP that crosses a state line returns every state. Metadata only, no rates: use get_gsa_perdiem_by_zipcode for per diem. Send ZIPs as strings so leading zeros survive.

Finds Department of Defense per diem by location name ('Kabul') or country or state name ('Afghanistan'), across CONUS and OCONUS, with no code needed. Returns lodging, local and proportional meal rates, incidentals and maximum per diem per matching location and season. `date` selects the rates in force on that day, `year` a fiscal year (Oct 1 to Sep 30); omit both for the current fiscal year.

Searches FEMA's Hotel and Motel National Master List (fire-safe lodging, required for reimbursed federal travel) by property name and city: every word of `q` must appear as a plain substring of the name or city, with no fuzzy matching. `state` narrows to one state; paginated with `offset`, `limit` (up to 200) and `total`. Returns FEMA ID, address, phone and property details, no rates: pair with GSA per diem for the lodging cap.

Return the latest General Schedule pay tables whose locality area matches every word of `q`: each word must be contained in the area name, case-insensitively, or equal its code. `grade` and `step` narrow the rates; no match returns an empty `results` list. Matching only looks at OPM's area names, not the counties and towns they cover, so a town missing from the names returns nothing, which does not mean Rest of U.S. Use get_opm_localities to resolve a place to its area.

Finds DSSR per diem by a partial, case-insensitive country or post name of at least three characters, with no country code needed. Returns lodging, M&IE and maximum per diem per matching post, today or on `date`, with the post code for precise follow-up lookups. A name that matches nothing is a 404 error, not an empty list. Once the ISO code is known, the country tools are more precise.