Buybacks schemas
Data models returned by Buybacks endpoints.
BuybackHistory
{
"instrument": {
"isin": string
},
"entity": {
"name": string
},
"listing": {
"symbol": string | null,
"mic": string
},
"data": [BuybackRecord],
"meta": {
"paging": ClassicPaging
}
}instrumentobjectisinstringentityobjectnamestringlistingobjectsymbolstring | nullmicstringdata[BuybackRecord]metaobjectpagingClassicPagingClassic page-based pagination response
BuybackRecord
{
"tradeDate": string<date>,
"executionVenue": {
"name": string,
"mic": string
},
"shares": integer<int64>,
"price": {
"average": number,
"high": number,
"low": number,
"currency": string,
"unit": string<enum>
},
"consideration": {
"value": number,
"currency": string,
"unit": string<enum>,
"basis": string<enum>
},
"purpose": string<enum>,
"programme": {
"cumulativeShares": integer<int64>
},
"disclosure": {
"id": string,
"href": string
}
}tradeDatestring<date>The date the shares were purchased. This is not the announcement date, which is typically the same day or up to three days later.
executionVenueobjectWhere the purchase executed, as named in the announcement. This is not listing.mic, which is where the instrument is listed. mic is given only where the name identifies a single market; issuers often report against a group of venues. The whole object is omitted when the announcement named no venue.
namestringmicstringpriceobjectaveragenumberVolume weighted average price, as stated in the announcement.
highnumberHighest price paid, where stated.
lownumberLowest price paid, where stated.
currencystringISO 4217 currency code, whether the price is in the major or minor unit. Omitted where the announcement stated no currency — some issuers print bare figures.
unitstring<enum>Whether the prices are in the major unit (pounds, dollars) or the minor unit (pence, cents).
"major", "minor"considerationobjectTotal value of the purchase, where the announcement states one.
valuenumbercurrencystringISO 4217 currency code.
unitstring<enum>"major", "minor"basisstring<enum>What the total covers. price — shares multiplied by price. cost — also includes dealing costs, commission and stamp duty.
"price", "cost"purposestring<enum>What became of the shares. cancellation — cancelled. treasury — held in treasury. employee_trust — bought for an employee benefit trust or share plan, which does not reduce the share count.
"cancellation", "treasury", "employee_trust"programmeobjectProgramme-to-date progress, where the announcement stated it. Omitted otherwise.
disclosureobjectThe announcement this record comes from.
idstringhrefstringPath to the full announcement.
BuybackSummary
{
"instrument": {
"isin": string
},
"entity": {
"name": string
},
"listing": {
"symbol": string | null,
"mic": string
},
"period": {
"from": string<date> | null,
"to": string<date> | null,
"trades": integer,
"shares": integer<int64>
},
"data": {
"navAccretion": {
"value": number,
"currency": string,
"unit": string<enum>,
"basis": string<enum>,
"nav": NavContext,
"shares": {
"votingRights": integer<int64>,
"asAt": string<date>
},
"unavailable": string
},
"averageDiscount": {
"value": number,
"unit": string<enum>,
"basis": string<enum>,
"nav": NavContext,
"inputs": {
"averagePrice": number,
"averageNav": number,
"currency": string,
"priceUnit": string<enum>
},
"unavailable": string
}
}
}instrumentobjectisinstringentityobjectnamestringlistingobjectsymbolstring | nullmicstringperiodobjectThe period measured, and the purchases it covers.
fromstring<date> | nullNull when no start date was given.
tostring<date> | nullNull when no end date was given.
tradesintegerNumber of purchases in the period.
dataobjectaverageDiscountobjectThe average discount of repurchase price to net asset value, weighted by the number of shares in each purchase. Negative values mean shares were bought below NAV.
valuenumberOmitted when the measure cannot be calculated. See unavailable.
unitstring<enum>"percent"basisstring<enum>How the figure was arrived at. confirmed — stated by the issuer. derived — calculated from stated values. estimated — depends on an assumption, such as measuring a purchase against the last NAV published before it.
"confirmed", "derived", "estimated"inputsobjectThe averages the percentage is calculated from.
averagePricenumberShare-weighted average price paid.
currencystringISO 4217 currency code.
priceUnitstring<enum>Both averages are in the minor unit of the currency.
"minor"