Aller au contenu principal

getting-started

I notice the actual file has sidebar_position: 2 and no slug field, differing from what I initially assumed. Let me produce the correct translation based on the real file content.

id: getting-started title: Démarrage sidebar_position: 2​

Démarrage

URL de base et conventions​

URL de basehttps://calc.dev.emrgex.com
Préfixechaque endpoint se trouve sous /v1
Taux et rendementsen décimales — 0.06 signifie 6 %
Prixpour 100 de valeur nominale
DatesISO YYYY-MM-DD
Type de contenuapplication/json

Votre première requête​

Valorisez un instrument stocké — référencez-le par instrument_id et fournissez un rendement :

curl -s https://calc.dev.emrgex.com/v1/quotes \
  -H 'content-type: application/json' \
  -d '{
    "quotes": [
      { "instrument_id": "MH12034", "input_kind": "yield", "input_value": 0.10,
        "settlement_date": "2026-06-09", "options": { "round": 6 } }
    ]
  }'

La réponse est une enveloppe de lot (batch) — une entrée par cotation, chacune avec son propre status :

{
  "data": [
    {
      "index": 0,
      "id": "MH12034",
      "status": "ok",
      "data": {
        "instrument_id": "MH12034",
        "convention": "NOMINAL · ACT/ACT.DRMH",
        "calculation_code": "ACT/ACT.DRMH|NOMINAL",
        "metrics": {
          "yield": 0.1,
          "dirty_price": 112.547645,
          "clean_price": 107.853124,
          "accrued_interest": 4.694521,
          "modified_duration": 5.12,
          "convexity": 33.7,
          "dv01": 0.0576
        }
      }
    }
  ]
}

Valoriser par le prix plutôt que par le rendement​

Définissez input_kind sur clean_price ou dirty_price et emrgex résout le rendement pour vous :

{ "instrument_id": "MH12034", "input_kind": "clean_price", "input_value": 107.85,
  "settlement_date": "2026-06-09", "options": { "round": 6 } }

Définir votre propre obligation (ad-hoc)​

Placez l'instrument en ligne dans instruments, puis référencez son id depuis quotes :

curl -s https://calc.dev.emrgex.com/v1/quotes \
  -H 'content-type: application/json' \
  -d '{
    "instruments": [
      { "id": "B1", "rate_type": "NOMINAL", "day_count": "ACT/ACT.ICMA",
        "coupon_type": "FIXED", "frequency": 2,
        "start": "2020-01-15", "maturity": "2030-01-15",
        "coupon_rate": 0.06, "face_value": 100 }
    ],
    "quotes": [
      { "instrument_id": "B1", "input_kind": "clean_price", "input_value": 95.5,
        "settlement_date": "2024-06-18", "options": { "round": 6 } }
    ]
  }'

Ajouter une taille de transaction​

Fournissez un amount pour obtenir les montants monétaires (montants de règlement) en plus des prix pour 100 :

{ "instrument_id": "MH12034", "input_kind": "yield", "input_value": 0.10,
  "amount_kind": "nominal", "amount_value": 1000000,
  "settlement_date": "2026-06-09", "options": { "round": 6 } }

Contrôle de santé​

curl https://calc.dev.emrgex.com/v1/health/livez
# {"status":"alive"}

:::tip Performance Pour valoriser en masse, envoyez de nombreuses cotations dans une seule requête /v1/quotes (un lot). Laissez with_cashflows désactivé sauf si vous avez besoin de l'échéancier de chaque obligation — cela rend les réponses bien plus compactes et rapides. :::

:::note Authentication Le service de développement est actuellement ouvert (sans clé API). Les déploiements en production peuvent activer la signature HMAC des requêtes. :::