ErgastApiClient - C# library for querying the Ergast Developer API (Formula 1 data)

PublishedSeptember 8, 2017

•3 min read•View as Markdown

ErgastApiClient - C# library for querying the Ergast Developer API (Formula 1 data)

Søren Kruse

Comments

Join the discussion

No comments yet. Be the first to comment.

More from this blog

Dynamic caching policy with Polly

Polly is great library for easily configuring different kinds of policies around code execution, be it retry, circuit breaker, caching or lots of other things. It's probably most often used around HTTP requests. If you haven't heard about it you defi...

Jan 15, 20213 min read

Unit Testing - Part 2: Naming, structure and readability

This is part 2 of my series on unit testing in .NET (C#) and will be about my conventions regarding naming unit tests, how to structure them and which parts to test. And lastly I will help you increase readability of assertions and potential error me...

Jan 9, 20217 min read

Unit Testing - Part 2: Naming, structure and readability

Unit Testing - Part 1: Getting started with unit tests in .NET

I feel like unit testing is very important and very beneficial in a lot of ways. It helps with not breaking existing functionality and thereby also making you more confident in changing code without fear of breaking important stuff. Often it also mak...

Dec 28, 20207 min read

Unit Testing - Part 1: Getting started with unit tests in .NET

Getting NSwag to work behind reverse proxy

I've been working with Swagger through NSwag a lot recently and also needed to get it to work when hidden behind a reverse proxy - i.e. another service forwarding a request to the service exposing the Swagger UI. Some of the issues I've had along the...

Dec 18, 20202 min read

Getting NSwag to work behind reverse proxy

NSubstitute - make async method (Task) throw an exception

The other day I was writing a unit test to verify what was supposed to happen when a Task would throw an exception when awaited. It wasn't as straight forward as I first assumed, but I quickly found this Stack Overflow post that helped me: https://st...

Dec 12, 20203 min read

NSubstitute - make async method (Task) throw an exception

Søren Kruse | .NET, C# and Azure

51 posts

Using the library

The library is pretty simple to use. Create (and reuse) an ErgastClient and then create one of the many request types:

RaceResultsRequest

LapTimesRequest

PitStopsRequest

CircuitInfoRequest

DriverInfoRequest

DriverStandingsRequest

...

You then use the client to execute the request and it will return a matching response type. The client takes care of caching for you, so you don't query the Ergast web service unnecessarily.

Below is a complete example of doing a RaceResultsRequest.

// Relevant imports using ErgastApi.Client; using ErgastApi.Ids; using ErgastApi.Requests; // The client should be stored and reused during the lifetime of your application var client = new ErgastClient(); // All request properties are optional (except 'Season' if 'Round' is set) var request = new RaceResultsRequest { Season = "2017", // or Seasons.Current for current season Round = "11", // or Rounds.Last or Rounds.Next for last or next round DriverId = "vettel", // or Drivers.SebastianVettel Limit = 30 // Limit the number of results returned Offset = 0 // Result offset (used for paging) }; // RaceResultsRequest returns a RaceResultsResponse // Other requests returns other response types RaceResultsResponse response = await client.GetResponseAsync(request); // We know it's only a single race, round 11 var race = response.Races.First(); race.Round; // 11 race.RaceName; // Hungarian Grand Prix race.Circuit.CircuitName; // Hungaroring // There is only one driver in the results - Vettel // Otherwise the results would be ordered by finishing position var vettel = race.Results[0]; vettel.Driver.Code; // VET vettel.FastestLap.LapNumber; // 69 vettel.Position; // 1 (finishing position)

The RaceResultsResponse contains a list of races matching the query. In this example there is only the one race (Round 11, Hungary, 2017). Each race contains info about the race, the circuit, time of the event etc. and of course the race results.

Each result (in this case there is only Vettel) contains info about the driver, finishing position, starting position (Grid), fastest lap etc.

The above example is the equivalent of this manual query. You can also see the actual JSON data by adding .json to the URL of the manual request.

Command Palette

Comments

More from this blog

Using the library

Source code