gionoa / formula1api

Swift Package for accessing Formula 1 data from the Ergast API

Formula 1 API

This Swift library provides endpoint access to Formula 1 data provided by the Ergast API. By using this library, you won't have to build the interactive layer yourself, and can just start consuming the data.

Installing / Getting started

Formula 1 API supports Swift Package Manager. To use SwiftPM, you should use the most recent version of Xcode to add this project.

Click File -> Swift Packages -> Add Package Dependency, enter Formula1API repo's URL. Or you can login Xcode with your GitHub account and just type Formula1API to search.

After select the package, you can choose the dependency type (tagged version, branch or commit). As of now, since there's no 1.0.0 release yet, choose master branch.

Initial Configuration

No configuration needed!

Deploying / Publishing

You can't run this library in your own server since it interacts with the live network. If you're interested in running your own server to fetch F1 data, check out this repository.

Features

Formula1API provides functions that allow you to access endpoints for data.

Currently, you can fetch:

• Circuits (all, specified season)
• Seasons
• Constructors (all, specified season)
• Race Schedule (specified season)
• Race Results (specified season)
• Qualifying Results (specified season),
• Pit Stops (specified season),
• Laps(specified season)

More endpoints will be accessible as development progresses.

Usage

Usage of this library within your app or package is simple.

Access endpoints via the Formula1API object.

Return closure example:

Formula1API.constructors(for: .year(2022)) { result in
    switch result {
    case .success(let constructors):
        print(constructors)
    case .failure(let error):
        print(error)
    }
}

Async-await example:

do {
    let constructors = try await Formula1API.constructors(for: .year(2022))
} catch error {
    print(error)
}

Licensing

The code in this project is licensed under MIT license.

formula1api's Issues

Add endpoint access for constructors

F1 Constructors

Add support for pagination

Ergast REST API responses (example) provide limit, offset, & total values for pagination. Add support for providing query items to specify a limit for each page.

Write README

Implement Pit Stops endpoint

https://ergast.com/api/f1/2011/5/pitstops.json

required: season, round

Implement Driver Info endpoint

http://ergast.com/api/f1/2019/drivers.json

Add MIT License

Add endpoint access for race schedule

Provide Public Access to Data Objects

Implement Lap Times endpoint

https://ergast.com/api/f1/2019/1/laps/1.json

required: season, round

Data returned from Library is not usable

Hello,

First of all, thank you for putting this together!
I added it to my project using Swift Package Manager and was able to use it to make calls to the Ergast API and print the resulting objects.

The problem is that the only object that is returned is the top-level one, and nothing else is accessible.
For example if I tried to get Circuit info for 2021, my code would be:

Formula1API.circuits(for: .year(2021)) { result in switch result { case .success(let circuits): print(circuits) case .failure(let error): print(error) } }

This works...BUT the "circuits" object can't be accessed (for example, I can't reach its "data" property because it is set to "internal" access-level only).

Unless I'm missing a step, this means I can't unpack the Circuits to get to an individual Circuit (or use the object in any other way).

I'd appreciate any help or guidance you can provide.

Thank you,

Marco

API implementation for self-hosted DB

Hi @gionoa, thanks for sharing this! I appreciate you setting this up, especially the models for Ergast responses.

I'm working against a self-hosted copy of the Ergast DB, and in your Readme under deploying and publishing, you recommended this nodejs repo. That repo works well for querying against my own db, but I wanted to point out that the url endpoints don't match up with those of the original Ergast API.

For example, getting drivers standings on Ergast:

https://ergast.com/api/f1/2008/driverStandings.json

Would have to be something like this in the node api:

http://localhost:5001/standings/drivers?year=2008

That being the case, I'd don't think think it would work as a drop in replacement to use your library against.

Are you using something else for your custom api? Or maybe I'm wrong and this library supports that url format?

Thanks again for sharing this.

Add endpoint access for Race Results

Implement MockURLSession

Implement Finishing Status endpoint

http://ergast.com/api/f1/2019/status.json

Implement Standings endpoint

https://ergast.com/api/f1/2019/driverStandings.json

Add endpoint access for seasons