Aller au contenu principal

Calendrier économique

Types de données

EventDto

AttributTypeDescription
idIntIdentifiant de l’évènement dans la base
titleStringIntitulé de l’évènement
dateDateDate de l’évènement
hourTimeL’heure de l’évènement
periodStringPériode de l’évènement
importanceEnum (LOW, MEDIUM, HIGH, HOLIDAY)Volatilité de l’évènement
categoryEventCategoryDto
zoneEventZoneDtoLes informations relatives à la région concernée
sourceEventSourceDtoSource de l’information
previousStringValeur précédente
currentStringValeur actuelle
previsionStringValeur prévisionnelle
commentStringCommentaire

EventCategoryDto

AttributTypeDescription
idIntIdentifiant de la catégorie
labelStringLe libellé de la catégorie

EventZoneDto

AttributTypeDescription
codeStringCode ISO alpha-2 de la zone
currencyStringCode de la devise
nameStringNom du pays

EventSourceDto

AttributTypeDescription
nameStringNom ou intitulé de la source
linkStringLien de la source

Liste des évènements économiques

Requête

Point de terminaison

/v1/events

Attributs de filtrage

AttributTypeDescription
limitNumberNombre d’éléments par page
pageNumberNuméro de page
qStringRechercher
fromDateRécupérer à partie d'une date
toDateRécupérer jusqu'à une date
categoriesList<Int>Filtrer par catégories
geo_typeEnum (COUNTRYZONE)
geo_valuesList<Int>Valeur du filtre géographique

Liste des catégories

IDValeur
1emploi
2inflation
3banques centrales
4balance
5activité économique
6crédit
7index de confiance
8obligation
9ferié

Réponse

AttributTypeDescription
metaPageDtoInformations relatives aux données
dataList<EventDto>Liste des évènements

Exemple

Requête

    curl -X GET 'https://sandbox-data.orishas-finance.com/api/v1/events' \
-h Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzd...

Réponse

{
"meta": {
"total": 3,
"per_page": 2,
"current_page": 1,
"total_pages": 2
},
"data" : [
{
"id": 37,
"title": "Positions nettes spéculatives CFTC sur le maïs",
"date": "2001-01-03",
"hour": "20:30",
"period": "",
"importance": "LOW",
"category": {
"id": 7,
"label": "index de confiance"
},
"country": {
"code": "BJ",
"name": "Benin",
"currency": "XOF"
},
"source": {
"name": "Traders",
"link": "http:\/\/www.url.gov\/MARKETREPORTS\/COMMITMENTSOFTRADERS\/INDEX.HTM"
},
"previous": "445,3K",
"current": "300K",
"prevision": "350K",
"comment": ""
},
...
]
}

Récupérer un évènement

Requête

Point de terminaison

/v1/events/{id}

Réponse

AttributTypeDescription
dataEventDtoDétails d'un évènement

Exemple

Requête

    curl -X GET 'https://sandbox-data.orishas-finance.com/api/v1/events/37' \
-h Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzd...

Réponse

"data" : {
"id": 37,
"title": "Positions nettes spéculatives CFTC sur le maïs",
"date": "2001-01-03",
"hour": "20:30",
"period": "",
"importance": "LOW",
"category": {
"id": 7,
"label": "index de confiance"
},
"country": {
"code": "BJ",
"name": "Benin",
"currency": "XOF"
},
"source": {
"name": "Traders",
"link": "http:\/\/www.url.gov\/MARKETREPORTS\/COMMITMENTSOFTRADERS\/INDEX.HTM"
},
"previous": "445,3K",
"current": "300K",
"prevision": "350K",
"comment": ""
}

Récupérer l'historique d'un évènement

Requête

Point de terminaison

/v1/events/history/{id}

Attributs de filtrage
AttributTypeDescription
limitNumberNombre d’éléments par page
pageNumberNuméro de page

Réponse

AttributTypeDescription
metaPageDtoInformations relatives aux données
dataList<EventDto>Liste de l'historique

Exemple

Requête

    curl -X GET 'https://sandbox-data.orishas-finance.com/api/v1/events/history/37' \
-h Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzd...

Réponse

{
"meta": {
"total": 3,
"per_page": 2,
"current_page": 1,
"total_pages": 2
},
"data" : [
{
"id": 27,
"title": "Positions nettes spéculatives CFTC sur le maïs",
"date": "2000-08-12",
"hour": "08:30",
"period": "",
"importance": "LOW",
"category": {
"id": 7,
"label": "index de confiance"
},
"country": {
"code": "BJ",
"name": "Benin",
"currency": "XOF"
},
"source": {
"name": "Traders",
"link": "http:\/\/www.url.gov\/MARKETREPORTS\/COMMITMENTSOFTRADERS\/INDEX.HTM"
},
"previous": "445,3K",
"current": "300,6K",
"prevision": "300K",
"comment": ""
},
...
]
}