Skip to main content

Extension

Extension schema — one historical extension of an extendable holding, as listed by GET /holding/{entity_code}/{holding_uid}/extension.

datedaterequired

Date the extension took effect

Example: 2024-01-01
finalYieldnumber | nullnullable

Final period yield, annualised APY (set on the final extension only).

Example: 5
maturitydaterequired

Maturity date set by this extension

Example: 2024-02-01
mmyA360Fnumberrequired

Return accrued from date to maturity, expressed in MMYA360F format. Use only when you specifically need this format.

Example: 4.84
mmyA365Fnumberrequired

Return accrued from date to maturity, expressed in MMYA365F format. Use only when you specifically need this format.

Example: 4.91
pricePerSharenumberrequired

Price per share at the extension

Example: 1.05
tradeDatedaterequired

Date the extension option was exercised (the portal calls this the option extension date). On a SPOT extendable it matches date. On a FORWARD extendable it can precede date, because the extension is traded on the option date while the new yield takes effect only when the previous period matures.

Example: 2024-01-01
uidstringrequired

Extension uid

Example: bcee2bb8569d406c9251dcc9bee38aff
yieldnumberrequired

Yield for this extension period (annualised APY).

Example: 5
Extension
{
  "date": "2024-01-01",
  "finalYield": 5,
  "maturity": "2024-02-01",
  "mmyA360F": 4.84,
  "mmyA365F": 4.91,
  "pricePerShare": 1.05,
  "tradeDate": "2024-01-01",
  "uid": "bcee2bb8569d406c9251dcc9bee38aff",
  "yield": 5
}