Ressource: fundshares-coupons
Permet de récupérer des coupons
Généralités- Un coupon est associé à une part par l'identifiant interne de la part idFundShare.
- Un coupon est identifié par sa date et son idFundShare
Lister les coupons
Requêtes de base:
https://services.opcvm360.com/api-v1/fundshares-couponsPar défaut la requête retourne une liste paginée de 500 coupons par page.
https://services.opcvm360.com/api-v1/fundshares-coupons?fundshares=1
Vous pouvez aussi avoir besoin de récupérer des coupons entre deux dates précises. Pour cela vous pouvez utiliser les paramêtres from et to qui permettent respectivement de spécifier une date de début et une date de fin.
https://services.opcvm360.com/api-v1/fundshares-coupons?fundshares=1&from=2011-06-24&to=2012-06-24
NOTE :
Par défaut un maximum de 500 coupons vous sont retournés.
Utilisez le paramètre limit afin d'augmenter ou diminuer cette limite et le paramêtre offset pour accéder aux pages suivantes.
Maintenez vos historiques de coupons à jour
Il arrive régulièrement que nous complétions ou corrigions les historiques de Coupons. Il peut donc devenir compliqué et coûteux en ressources de maintenir vos historiques à jour. Afin de simplifier ce maintient nous vous conseillons d'utiliser la méthode suivante.
Récupérer uniquement les données mises à jours
Cette solution consiste à demander à l'API de retourner uniquement les valeurs qui ont été ajoutées ou modifiées dans notre base de données depuis votre dernière requête du même type. Vous êtes donc sûr de ne rater aucune mise à jour sans pour autant reparcourir la liste complète des historiques. Pour cela utilisez le paramètre upFromDate=2017-01-22 pour donner la date de votre dernière requête de ce type.
Optionnellement avec ce paramêtre :- upFromTime=10:05:00 pour préciser l'heure de début
- upToDate=2017-01-22 pour préciser une date de fin
- upToTime=10:05:00 pour préciser l'heure de fin
Exemple d'utilisation:
https://services.opcvm360.com/api-v1/fundshares-coupons?upFromDate=2017-01-22&upFromTime=10:05:00
https://services.opcvm360.com/api-v1/fundshares-coupons?fundshares=1,2&upFromDate=2017-01-22&upFromTime=10:05:00
https://services.opcvm360.com/api-v1/fundshares-coupons?fundshares=1,2&from=2017-01-22&to=2017-01-24&limit=3500&offset=3500On retourne les historiques de coupons des parts 1 et 2 entre le 22/01/2017 et le 24/01/2017 avec maximum 3500 lignes et à partir de la ligne 3500
NOTE : le paramètre upFromDate ne peut être combiné aux paramêtres from et to décris en première partie.
Liste des informations disponibles pour la ressource
Déjà client ? Connectez-vous pour n'afficher que les données disponibles avec vos accès.
| Nom dans l'API | Description | Type |
|---|---|---|
| idFundShare | Identifiant interne de la part. | Int |
| date | Date du coupon. | Date => YYYY-MM-DD |
| value | Valeur du coupon. | Float |