In this section: Transfer partners

Transfer partners

Transfer partner routes and ratios, point valuations, and running a transfer plan against a member's balances.

compare_transfer_options

What a balance of points is worth across transfer paths, with the arithmetic shown -- the points-quantity question, distinct from get_transfer_partners (which lists WHICH paths exist, not what YOUR points are worth). Call program only (from), target only (to), or both (one specific path, e.g. 60k UR → Hyatt).

ScopeQuota
miles:readstandard
NameTypeRequiredDescription
pointsintegerrequiredThe points balance to value, as a whole number of points.
programstringSource currency the points are in (e.g. "Chase Ultimate Rewards"). Pass alone to see every path from it, or with target for one path.
targetstringDestination program (e.g. "World of Hyatt"). Pass alone to see every path into it, or with program for one path.
cardholderstringWhose points these are: a household member's name or id, or "me". Omit for the account holder's own. An unknown name is refused.

get_transfer_partners

Transfer partner lookup. mode='from_program' lists where a currency (e.g. 'Chase Ultimate Rewards') transfers; 'to_program' lists which currencies reach a destination (e.g. 'World of Hyatt'); 'auto' infers.

ScopeQuota
miles:readstandard
NameTypeRequiredDescription
querystringrequiredA currency or loyalty program name (e.g. "Chase Ultimate Rewards" or "World of Hyatt").
modestring"from_program" lists where the named currency transfers; "to_program" lists which currencies reach the named destination; "auto" (default) infers which from the query.

get_valuations

Point valuations (cents per point), using your custom values when set and defaults otherwise. Includes issuer rules for direct bank deposits.

ScopeQuota
miles:readstandard
NameTypeRequiredDescription
programsstring[]Loyalty program names to limit the result to (e.g. ["Chase Ultimate Rewards", "World of Hyatt"]); omit for every program on file.

plan_transfer

"I need N points at program X -- which of my HELD currencies gets me there cheapest?" The advisor flagship: ranks the loyalty currencies you've told Miles you hold (get_balances) by cheapest path to target_program -- transfer graph x ratios x active bonuses x transfer minimums/increments x your own valuations -- including two-currency split suggestions and "you hold it but not enough" rows. Deterministic, receipt-style, built on the same functions compare_transfer_options uses, so the two tools cannot disagree about a shared leg.

ScopeQuota
miles:readstandard
NameTypeRequiredDescription
target_programstringrequiredThe destination loyalty program (e.g. "World of Hyatt"). An unrecognized name returns an unknown_program error rather than a guess.
points_neededintegerrequiredHow many of the target program's points are needed, as a whole number; never dollars and never your own balance.
cardholderstringRank one household member's balances: their name or id, or "me". Omit for every cardholder. An unknown name is refused.

portfolio_review

"Here are my balances -- where should I focus?" Ranks every loyalty currency the member has told Miles they hold against a redemption goal, and says which one to focus on, which to stop growing, and why.

ScopeQuota
miles:readstandard
NameTypeRequiredDescription
goalstringRedemption goal: flights_premium, flights_economy, hotels or cash_like. Omit for a rankings block across all four plus a suggested_goal; any other value, flexible included, returns a validation_error naming the four.
cardholderstringA household member's name or id. Omit for every cardholder, reported separately. A name nobody in the household has returns an unknown_cardholder error listing the names that exist; one with no balances on file returns rows: [], NOT empty_ledger.

reset_valuation

Reset a custom valuation back to the reasonable redemption value. Requires wallet-change access.

ScopeQuota
miles:writestandard
NameTypeRequiredDescription
point_typestringrequiredThe program or currency whose custom valuation to reset to the reasonable redemption value.

set_valuation

Set the user's custom point/mile valuations (cents per point). Pass valuations to set several at once. Requires wallet-change access.

ScopeQuota
miles:writestandard
NameTypeRequiredDescription
point_typestringThe program or currency to set one valuation for (e.g. "Chase Ultimate Rewards"); pair with valuation.
valuationnumberThe value in cents per point (1.8 means 1.8 cents), not dollars and not a percentage; pair with point_type.
valuationsobjectSeveral valuations at once, program name to cents per point (e.g. {"Chase Ultimate Rewards": 1.8, "World of Hyatt": 2.1}).

where_to_credit

Answers "which frequent flyer program should I credit this flight to?". Ranks every program that can take the flight by what the miles are worth TO THIS USER -- their own valuations, balances, and elite tier -- not by the raw mileage count. That distinction matters: on most economy fares nearly every program pays the SAME percentage, so the mileage number does not decide the answer and the value does.

ScopeQuota
miles:readexpensive
NameTypeRequiredDescription
segmentsobject[]requiredOne entry per flown leg (a return trip is two), each {operating_airline, origin, destination, fare_class}. operating_airline is the two-letter IATA code of the airline that OPERATES the flight, not the one on the ticket; fare_class is the single booking-class letter from the ticket, and it decides the answer -- ask for it rather than guessing one from the cabin.
programsstring[]Limit the ranking to these programs. Omit to rank every program the source lists.
memberstringHousehold member who is flying, so their balances and elite tier are used instead of the account holder's.