Rechercher des équidés

GET

/v1/equides

const url = 'https://api-equides.org/v1/equides?race=Pur%20Sang&robe=Bai&sexe=Femelle&discipline=TROT%20COURSE&indice=ISO&annee_naissance=2015&nom=qabalah&annee_min=2010&annee_max=2020&avec_performances=true&tri=-annee&vue=resume&limite=20&offset=0';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

use reqwest;

#[tokio::main]
pub async fn main() {
    let url = "https://api-equides.org/v1/equides";

    let querystring = [
        ("race", "Pur Sang"),
        ("robe", "Bai"),
        ("sexe", "Femelle"),
        ("discipline", "TROT COURSE"),
        ("indice", "ISO"),
        ("annee_naissance", "2015"),
        ("nom", "qabalah"),
        ("annee_min", "2010"),
        ("annee_max", "2020"),
        ("avec_performances", "true"),
        ("tri", "-annee"),
        ("vue", "resume"),
        ("limite", "20"),
        ("offset", "0"),
    ];

    let client = reqwest::Client::new();
    let response = client.get(url)
        .query(&querystring)
        .send()
        .await;

    let results = response.unwrap()
        .json::<serde_json::Value>()
        .await
        .unwrap();

    dbg!(results);
}

curl --request GET \
  --url 'https://api-equides.org/v1/equides?race=Pur%20Sang&robe=Bai&sexe=Femelle&discipline=TROT%20COURSE&indice=ISO&annee_naissance=2015&nom=qabalah&annee_min=2010&annee_max=2020&avec_performances=true&tri=-annee&vue=resume&limite=20&offset=0'

Les filtres d’une même dimension se combinent en OU, les dimensions différentes en ET.

Les lignes sont renvoyées en résumé par défaut ; vue=complet sert les fiches entières.

Aucune réponse ne porte de lien déductible d’un identifiant : les gabarits d’URL sont publiés par GET /.

Parameters

Query Parameters

race

Array<string>

Race, répétable pour un OU (?race=A&race=B) ou séparée par des virgules. Insensible à la casse et aux accents. Le jeu compte 11 747 races distinctes ; valeurs admises sur /v1/referentiels/races.

Example

Pur Sang

robe

Array<string>

Robe, mêmes règles que race. Valeurs admises : /v1/referentiels/robes.

Example

Bai

sexe

Array<string>

Sexe tel qu’écrit par la source : Femelle, Male, Hongre, Indeter.

Example

Femelle

discipline

Array<string>

Restreint aux équidés portant des performances dans cette discipline. Valeurs admises : /v1/referentiels/disciplines.

Example

TROT COURSE

indice

Array<string>

Restreint aux équidés portant un indice de ce code (BTR, ISO, ITR…). Valeurs admises : /v1/referentiels/codes_indice.

Example

ISO

annee_naissance

Array<integer>

Millésime de naissance, répétable.

Example

nom

string

Recherche sur le nom. Chaque mot de la requête est traité comme un préfixe et tous doivent être présents : qabalah mer retrouve « QABALAH MERCURY ».

Example

qabalah

annee_min

integer

Millésime de naissance minimal, inclus.

Example

annee_max

integer

Millésime de naissance maximal, inclus.

Example

avec_performances

boolean

Restreint aux équidés portant (ou non) des indices de performance. Accepte true, false, 1, 0, oui, non. Attention : false ne signifie pas que l’équidé n’a jamais concouru, seulement qu’aucun indice n’est publié — 75,1 % du jeu est dans ce cas.

Example

true

tri

string

default: naturel

Allowed values: naturel nom annee -naturel -nom -annee

Ordre : naturel (ordre du fichier source, défaut), nom, annee. Préfixer par - inverse le sens. Les millésimes absents sont toujours placés en fin de liste.

Example

-annee

vue

string

default: resume

Allowed values: resume complet

Niveau de détail des lignes renvoyées : resume (défaut, ~180 octets par ligne) ou complet (fiche entière, ~1,1 Kio par ligne).

Example

resume

limite

integer

default: 20 >= 1 <= 100

Lignes par page (1 à 100, défaut 20). Une valeur hors bornes est refusée par un 400.

Example

offset

integer

0 <= 10000

Décalage, plafonné à 10000 ; au-delà, un 400. La pagination profonde dégrade le service : pour parcourir le jeu entier, téléchargez le fichier publié.

Example

Responses

200

Page de résultats.

application/json

object

donnees

required

Résumés par défaut, fiches complètes si vue=complet.

Array

One of:

object
object

Vue allégée servie par les listes. La fiche complète s’obtient sur /v1/equides/{id} — aucun lien n’est répété par ligne, il se déduit de l’identifiant.

object

annee_naissance

integer

required

string

nom

required

string

race

required

string

robe

string

sexe

required

string

Allowed values: Femelle Male Hongre Indeter

pagination

required

object

limite

required

integer

note

Présent seulement quand la sélection dépasse la profondeur de pagination : le reste n’est pas atteignable par cette route.

string

offset

required

integer

precedent

URI de la page précédente. Nulle sur la première page.

string | null

suivant

URI de la page suivante, filtres conservés. Nulle sur la dernière page ou lorsque la profondeur maximale est atteinte.

string | null

total

required

Lignes correspondant aux filtres, avant découpage.

integer

Example

{
  "donnees": [
    {
      "annee_naissance": 2026,
      "id": "Z4ogLhlkS2CeUdq0bZ0YFw",
      "nom": "QABALAH MERCURY",
      "race": "Trotteur Francais",
      "robe": "Bai",
      "sexe": "Femelle"
    }
  ]
}

304

Contenu inchangé depuis l’ETag fourni en If-None-Match. Aucun corps, et rien n’est recalculé côté service.

400

Paramètre inconnu, valeur hors bornes, ou modalité que le référentiel n’admet pas.

application/problem+json

Corps d’erreur conforme à la RFC 9457 (« Problem Details for HTTP APIs »), servi en application/problem+json. Les champs parametre et indice sont des extensions, que la RFC autorise.

object

detail

required

Explication propre à cette occurrence.

string

documentation

string

indice

Extension : piste de correction — valeurs admises, référentiel à consulter, ou paramètre le plus proche en cas de faute de frappe.

string

parametre

Extension : paramètre fautif, quand l’erreur en désigne un.

string

status

required

integer

title

required

Résumé lisible, stable pour un type donné.

string

type

required

URI du type de problème, relative — le client la résout contre l’URI de la requête. Elle pointe vers la section correspondante de la documentation.

string

Example

{
  "detail": "paramètre inconnu `rase`",
  "documentation": "https://docs.api-equides.org",
  "indice": "vouliez-vous dire `race` ?",
  "parametre": "rase",
  "status": 400,
  "title": "Paramètre invalide",
  "type": "/#erreur-parametre-invalide"
}

429

Quota de débit dépassé pour l’adresse appelante. Retry-After indique le délai.

application/problem+json

Corps d’erreur conforme à la RFC 9457 (« Problem Details for HTTP APIs »), servi en application/problem+json. Les champs parametre et indice sont des extensions, que la RFC autorise.

object

detail

required

Explication propre à cette occurrence.

string

documentation

string

indice

Extension : piste de correction — valeurs admises, référentiel à consulter, ou paramètre le plus proche en cas de faute de frappe.

string

parametre

Extension : paramètre fautif, quand l’erreur en désigne un.

string

status

required

integer

title

required

Résumé lisible, stable pour un type donné.

string

type

required

URI du type de problème, relative — le client la résout contre l’URI de la requête. Elle pointe vers la section correspondante de la documentation.

string

Example

{
  "detail": "paramètre inconnu `rase`",
  "documentation": "https://docs.api-equides.org",
  "indice": "vouliez-vous dire `race` ?",
  "parametre": "rase",
  "status": 400,
  "title": "Paramètre invalide",
  "type": "/#erreur-parametre-invalide"
}

503

Capacité de traitement simultané atteinte, délai maximal dépassé, ou données non chargées. Retry-After indique le délai.

application/problem+json

Corps d’erreur conforme à la RFC 9457 (« Problem Details for HTTP APIs »), servi en application/problem+json. Les champs parametre et indice sont des extensions, que la RFC autorise.

object

detail

required

Explication propre à cette occurrence.

string

documentation

string

indice

Extension : piste de correction — valeurs admises, référentiel à consulter, ou paramètre le plus proche en cas de faute de frappe.

string

parametre

Extension : paramètre fautif, quand l’erreur en désigne un.

string

status

required

integer

title

required

Résumé lisible, stable pour un type donné.

string

type

required

URI du type de problème, relative — le client la résout contre l’URI de la requête. Elle pointe vers la section correspondante de la documentation.

string

Example

{
  "detail": "paramètre inconnu `rase`",
  "documentation": "https://docs.api-equides.org",
  "indice": "vouliez-vous dire `race` ?",
  "parametre": "rase",
  "status": 400,
  "title": "Paramètre invalide",
  "type": "/#erreur-parametre-invalide"
}