Devises

Le service des devises permet d'accéder aux paires de devises suivies par Orishas ainsi qu'à leur historique de cours.

Types de données

CurrencyDto

Attribut	Type	Description
id	Int	Identifiant unique de la paire de devises
code	String	Code de la paire de devises (ex: EURXOF)
name	String	Intitulé de la paire de devises
base	String	Code de la devise de base
target	String	Code de la devise cible

Liste des devises

Requête

Point de terminaison

/v1/currencies

Attributs de filtrage

Attribut	Type	Description
limit	Number	Nombre d'éléments par page (20 par défaut)
page	Number	Numéro de page
name	String	Rechercher par intitulé de la paire de devises
code	String	Filtrer par code de la paire de devises (insensible à la casse)
base	String	Filtrer par code de la devise de base
target	String	Filtrer par code de la devise cible

Réponse

Attribut	Type	Description
meta	PageDto	Informations relatives aux données
data	List<CurrencyDto>	Liste des paires de devises

Exemple

Requête

curl --location 'https://sandbox-data.orishas-finance.com/api/v1/currencies' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...'

Réponse

data.json

{
  "meta": {
    "total": 24,
    "count": 20,
    "per_page": 20,
    "current_page": 1,
    "total_pages": 2
  },
  "data": [
    {
      "id": 5201,
      "code": "EURXOF",
      "name": "EURO / FRANC CFA (BCEAO)",
      "base": "EUR",
      "target": "XOF"
    },
    {
      "id": 5202,
      "code": "USDXOF",
      "name": "DOLLAR AMERICAIN / FRANC CFA (BCEAO)",
      "base": "USD",
      "target": "XOF"
    }
  ]
}

Récupérer une devise

Récupérer les informations d'une paire de devises en utilisant son identifiant unique.

Requête

Point de terminaison

/v1/currencies/{id}

Réponse

Attribut	Type	Description
data	CurrencyDto	Infos de la paire de devises

Exemple

Requête

curl --location 'https://sandbox-data.orishas-finance.com/api/v1/currencies/5201' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...'

Réponse

data.json

{
  "data": {
    "id": 5201,
    "code": "EURXOF",
    "name": "EURO / FRANC CFA (BCEAO)",
    "base": "EUR",
    "target": "XOF"
  }
}