La liste des instruments

GET

/instruments

curl --request GET \
  --url 'https://example.com/instruments?nature=placement_collectif&etat=en_preparation&regime_juridique=l_214_164&profil=solidaire&restriction=ferme_aux_souscriptions&page=1&taille=50' \
  --header 'Authorization: Bearer <token>'

La collection du référentiel. La recherche par référence externe tient lieu de résolution d’identifiant : chaque catégorie de parts étant un instrument, un ISIN mène à exactement une ligne.

Autorisations

• authentification
  instruments:consultation

Paramètres

Paramètres (query)

nature

string

Allowed values: placement_collectif ccb devise

etat

string

Allowed values: en_preparation commercialisable annule absorbe liquide

L’état du cycle (un terminus reste servi).

vehicule

string

>= 1 characters

societe_de_gestion

string

>= 1 characters

L’intervenant jouant le rôle de société de gestion à la date du jour.

regime_juridique

string

Allowed values: l_214_164 l_214_165 l_214_165_1 reprise_l_3332_16

profil

string

Allowed values: solidaire relais garanti a_formule nourricier

restriction

string

Allowed values: ferme_aux_souscriptions ferme_aux_rachats suspendu ferme_aux_nouveaux_versements

Ne servir que les instruments portant une restriction en vigueur de ce type.

reference

string

>= 1 characters

Une référence externe exacte — l’ISIN de l’instrument.

nom

string

>= 1 characters

Une recherche sur le libellé.

page

integer

default: 1 >= 1

La page demandée, à partir de 1.

taille

integer

default: 50 >= 1 <= 500

Le nombre de lignes par page.

Réponses

200

La page demandée — vide si aucun instrument ne répond.

Media typeapplication/json

object

lignes

required

Array<object>

object

instrument

required

L’identifiant publié.

string

libelle

required

string

nature

required

string

Allowed values: placement_collectif ccb devise

etat

required

string

Allowed values: en_preparation commercialisable annule absorbe liquide

isin

L’ISIN de l’instrument

string

vehicule

Le véhicule porteur — absent pour un CCB et une devise.

object

vehicule

required

string

type

required

string

Allowed values: fcpe sicavas

nom_legal

string

restrictions_en_vigueur

Les types de restriction en vigueur au jour de la lecture — le détail vit à la fiche.

Array<string>

Allowed values: ferme_aux_souscriptions ferme_aux_rachats suspendu ferme_aux_nouveaux_versements

derniere_valeur

La dernière valeur applicable de l’instrument.

object

date_calcul

required

string format: date

valeur_part_ue6

required

integer

total

required

Le nombre total du filtre — null quand on ne sait pas compter à coût raisonnable.

integer | null

Example

{
  "lignes": [
    {
      "nature": "placement_collectif",
      "etat": "en_preparation",
      "vehicule": {
        "type": "fcpe"
      },
      "restrictions_en_vigueur": [
        "ferme_aux_souscriptions"
      ]
    }
  ]
}

400

La demande est irrecevable (date mal formée, bornes incohérentes…) — le motif nomme le champ.

Media typeapplication/json

object

motif

required

Le motif, qui nomme le champ ou l’identifiant en cause.

string

Example^generated

{
  "motif": "example"
}

401

Aucune identité présentée (l’exigence est du contrat, le mécanisme de l’assemblage).

403

L’identité présentée n’a pas la famille d’accès instruments:consultation.