Calendrier économique

Types de données

EventDto

Attribut	Type	Description
id	Int	Identifiant de l’évènement dans la base
title	String	Intitulé de l’évènement
date	Date	Date de l’évènement
hour	Time	L’heure de l’évènement
period	String	Période de l’évènement
importance	Enum (LOW, MEDIUM, HIGH, HOLIDAY)	Volatilité de l’évènement
category	EventCategoryDto
zone	EventZoneDto	Les informations relatives à la région concernée
source	EventSourceDto	Source de l’information
previous	String	Valeur précédente
current	String	Valeur actuelle
prevision	String	Valeur prévisionnelle
comment	String	Commentaire

EventCategoryDto

Attribut	Type	Description
id	Int	Identifiant de la catégorie
label	String	Le libellé de la catégorie

EventZoneDto

Attribut	Type	Description
code	String	Code ISO alpha-2 de la zone
currency	String	Code de la devise
name	String	Nom du pays

EventSourceDto

Attribut	Type	Description
name	String	Nom ou intitulé de la source
link	String	Lien de la source

Liste des évènements économiques

Requête

Point de terminaison

/v1/events

Attributs de filtrage

Attribut	Type	Description
limit	Number	Nombre d’éléments par page
page	Number	Numéro de page
q	String	Rechercher
from	Date	Récupérer à partie d'une date
to	Date	Récupérer jusqu'à une date
categories	List<Int>	Filtrer par catégories
geo_type	Enum (COUNTRY	ZONE)
geo_values	List<Int>	Valeur du filtre géographique

Liste des catégories

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

Réponse

Attribut	Type	Description
meta	PageDto	Informations relatives aux données
data	List<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

Attribut	Type	Description
data	EventDto	Dé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

Attribut	Type	Description
limit	Number	Nombre d’éléments par page
page	Number	Numéro de page

Réponse

Attribut	Type	Description
meta	PageDto	Informations relatives aux données
data	List<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": ""
		},
        ...
    ]
}