Hippomundo Enterprise API
Guides

Sandbox

Build and test with fictional data, and find a demo request for every operation.

Fictional data for building and testing

The sandbox at https://sandbox.enterprise.hippomundo.com/api serves a small set of fictional horses, riders, competitions and studbooks. It uses the production prices, paid with free play credits, needs no payment details, and is rate limited. Create an account at https://sandbox.enterprise.hippomundo.com/register and an API key in its portal. Sandbox keys work only on the sandbox, and sandbox IDs and names do not exist in production.

Play credits

Sandbox requests cost the same credits as in production, so charging, retries with the same Idempotency-Key, idempotency_conflict and insufficient_credits behave exactly as they will for your production integration. The price list shows what each operation costs. Requests are paid with free play credits: each sandbox workspace starts every UTC day with 50,000, the previous day's remainder expires at 00:00 UTC, and play credits cannot be bought, refunded or moved to production. The sandbox portal shows your play-credit balance and the next top-up, and getUsage returns the balance.

Name search on the sandbox

Horse and rider name search works as in production: it matches names that start with the text you send, ignoring case, so Val finds Valcourt and Jolie van finds Jolie van 't Distelveld, while Distelveld, a later word of that name, finds nothing.

Sandbox dates

Sandbox results end a few days before the sandbox data was last loaded, and its competitions span the 21 months before that. The studbook and offspring feeds accept at most 30 days, so their demo requests below use the last 30 days.

Weekly data refresh

The sandbox reloads its data every Monday at about 03:30 Brussels time, so recent results never run out. The same horses, riders, competitions and IDs come back, with every date moved forward by whole weeks. For a second or two, requests can take longer, and a few may answer with a retryable 503 service_unavailable or 504 dependency_timeout, which is never charged. A next_page_token from before the refresh answers 400 page_token_expired; start that list again from the first page.

Demo requests

Each request below returns data on the sandbox. Send it with your sandbox key in the apikey header after the base URL. With the MCP server, call the tool named in brackets with the same parameters. The list requests use the default page size, which is the largest: a page costs the same credits whatever its size, so a smaller page_size saves nothing.

Search

  • GET /v1/search/horses?name=Val (searchHorses): Horses whose names start with Val, such as Valcourt and Valdemar.
  • GET /v1/search/horses?fei=103-pa-19 (searchHorses): The horse with FEI number 103PA19, typed in lower case with hyphens.
  • GET /v1/search/horses?ueln=056-svw-000900004 (searchHorses): The same horse by its UELN 056SVW000900004. Results never show FEI numbers or UELNs.
  • GET /v1/search/riders?name=Wannes (searchRiders): Riders whose names start with Wannes.
  • GET /v1/competitions?name=Herentals (searchCompetitions): A jumping competition and its ID.

Competitions, editions and classes

  • GET /v1/competitions/930001/editions (listCompetitionEditions): The editions of one competition.
  • GET /v1/editions/940001/classes (listEditionClasses): The classes of one edition.
  • GET /v1/classes/950001/results (listClassResults): Results of one jumping class, best placings first.

Results of a horse or rider

  • GET /v1/horses/900100/results (listHorseResults): Results of one horse.
  • GET /v1/riders/910001/results (listRiderResults): Results of one rider.

Studbooks and offspring

  • GET /v1/studbooks (listStudbooks): Every sandbox studbook and its ID.
  • GET /v1/studbooks/920001/results?date_from={29 days ago}&date_to={today} (listStudbookResults): Results of horses in one studbook over the last 30 days, the longest allowed range. Replace {today} and {29 days ago} with dates in YYYY-MM-DD form.
  • GET /v1/horses/900030/offspring/results?parent_role=sire&date_from={29 days ago}&date_to={today} (listHorseOffspringResults): Results of a stallion's offspring over the last 30 days, with the same dates. With parent_role=dam the same request returns an empty page.

Pedigrees

  • GET /v1/horses/900001/pedigree/breeding (readBreedingPedigree): The subject, ancestors and dam families with descriptive fields.
  • GET /v1/horses/900001/pedigree/sport (readSportPedigree): Sport-selected relatives, current rating, levels and ranked results.
  • GET /v1/horses/900001/pedigree/performance (readPerformancePedigree): The performance family set, up to five best results and international prize money.
  • GET /v1/horses/900001/pedigree/black-type (readBlackTypePedigree): The black-type family selection and up to three best results.

Superseded IDs

  • GET /v1/horses/980001/pedigree/breeding (readBreedingPedigree): A superseded horse ID. The response describes horse 900001, and the Hippomundo-Resolved-From header carries 980001.
  • GET /v1/riders/981001/results (listRiderResults): A superseded rider ID. The results are those of rider 910001, and the Hippomundo-Resolved-From header carries 981001.

Account

  • GET /v1/usage (getUsage): Your balance, this month's spending and recent activity.
  • GET /v1/openapi.json (getEntitlementFilteredOpenAPI): The OpenAPI document for the operations your key may use.