Ressource: indexes-history

Cette ressource permet de récupérer et maintenir à jours les historiques de vos indices.
Le lien entre un historique et son indice est effectué par le biais de l'idIndex

Lister les historiques

Requêtes de base:

Récupérer la liste complète des historiques:
Tester
https://services.opcvm360.com/api-v1/indexes-history
Par défaut la requête retourne une liste paginé de 500 valeurs par page.
Récupérer l'historique de l'indice idIndex 1 :
Tester
https://services.opcvm360.com/api-v1/indexes-history?indexes=1

Vous pouvez aussi avoir besoin de récupérer des historiques 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 d'historique.

Récupérer l'historique de l'indice idIndex 1 depuis le 24/06/2011 au 24-06-2012:
Tester
https://services.opcvm360.com/api-v1/indexes-history?indexes=1&from=2011-06-24&to=2012-06-24

NOTE : Par défaut un maximum de 500 valeurs vous sont retournées.
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 à jour

Il arrive régulièrement que nous complétions ou corrigions les historiques. 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=2013-11-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=2013-11-23 pour préciser une date de fin
  • upToTime=10:05:00 pour préciser l'heure de fin

Exemple d'utilisation:

Récupérer les historiques de tous les indices mis à jour depuis le 22/11/2013 à 10:05:00
Tester
https://services.opcvm360.com/api-v1/indexes-history?upFromDate=2013-11-22&upFromTime=10:05:00
Récupérer les historiques des indices 1 et 2 mis à jour depuis le 22/11/2013 à 10:05:00
Tester
https://services.opcvm360.com/api-v1/indexes-history?indexes=1,2&upFromDate=2013-11-22&upFromTime=10:05:00
Utiliser les paramêtres de pagination :
Tester
https://services.opcvm360.com/api-v1/indexes-history?indexes=1,2&from=2011-06-24&to=2012-06-24&limit=3500&offset=3500
On retourne les historiques des indices 1 et 2 entre le 24/06/2011 et le 24/06/2012 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
idIndex Identifiant interne de l'indice. int
date Date de la valeur de l'indice. Date => YYYY-MM-DD
value Valeur de l'indice. Float