Aller au contenu principal

Instruments : stockés ou ponctuels

emrgex distingue les instruments stockés des instruments ponctuels par une seule chose : le fait que l'obligation figure déjà ou non dans le catalogue.

Où il est définiÉchéancier des fluxValorisation
Stockédans le catalogue (référencé par id)persisté (l'échéancier de l'émetteur)recalculée à chaque appel
Ponctuelen ligne dans votre requêtegénéré à partir des caractéristiquesrecalculée à chaque appel

Dans les deux cas, les prix, taux de rendement, durations, convexité et intérêts courus ne sont jamais stockés — ils sont recalculés à partir de l'échéancier à chaque requête, selon la convention de l'instrument.

Champs de l'instrument

Lorsque vous définissez un instrument ponctuel (ou inspectez un instrument stocké), voici les champs disponibles :

ChampRequisRemarques
idoui (ponctuel)votre référence pour l'instrument dans la requête
rate_typeouiNOMINAL / EFFECTIVE / AT_MATURITY / PRICE_QUANTITY
day_countoui¹nom FpML/ISDA ; non utilisé pour PRICE_QUANTITY
coupon_typenonFIXED (par défaut) ou ACCRUAL
frequencyoui²nombre de coupons par an
startouidate d'émission / de premier accrual
maturityoui
coupon_ratenoncoupon annuel sous forme décimale (0.06 = 6 %)
face_valueouigénéralement 100
unit_nominalnondénomination négociable minimale ; arrondit un nominal dérivé
eomnondécalage en fin de mois (end-of-month)
ex_div_daysnonjours de détachement du coupon (ex-dividende)
amortizationsnontableau de { date, amount } — voir ci-dessous
callsnontableau de { date, price } — rend l'obligation remboursable par anticipation (callable)

¹ Requis sauf pour PRICE_QUANTITY. ² AT_MATURITY / PRICE_QUANTITY forcent frequency à 1.

Obligations amortissables

Ajoutez un tableau amortizations de { date, amount } (principal remboursé à chaque date). Les obligations amortissables sont cotées sur le nominal en cours (outstanding) (le standard de marché) : les prix et le DV01 sont ajustés à la fraction en cours, tandis que les durations, la convexité et les taux de rendement sont invariants d'échelle. Une valeur amount_value fournie est interprétée comme le nominal en cours (current).

Obligations remboursables par anticipation (callable)

Ajoutez un tableau calls de { date, price } (prix de remboursement pour 100 de nominal). Lorsque vous cotez une obligation callable par le prix, définissez options.yield_worst: true pour recevoir également le yield-to-worst (le min du yield-to-maturity et de chaque yield-to-call). Voir Métriques.

Parcourir le catalogue stocké

# list instruments (filterable, paginated)
curl "https://calc.dev.emrgex.com/v1/admin/instruments?issuer=Hacienda&limit=20"

Filtres utiles (tous optionnels, combinés en ET) : rate_type, day_count, calculation_code, currency, issuer (sous-chaîne), name (sous-chaîne), q (recherche dans id/nemo/isin/issuer/name), amortizing, callable, maturity_from / maturity_to, coupon_min / coupon_max, ainsi que sort, order, limit, offset. limit=0 renvoie uniquement le nombre total. Voir la référence de l'API.