instruments.fyi

instruments.fyi provides API access to localized musical instruments and their tunings provided by InstrumentKit.

Table of Contents

• Work In Progress
• Usage
• Performance
• Contributing
• Support
• Credits
• License

Work In Progress

⚠️ This package is very much a work in progress. Here are some immediate next steps.

• The underlying InstrumentKit module needs initial review, prior to loading it with an immense amount of data.
• The localization are only available in English at this time, but support for Spanish, German, and French will be the first follow-ups.

Usage

Visit instruments.fyi for API documentation.

Performance

instruments.fyi is built using Vapor, a Server-side Swift framework.

Please note: This server behind this API has very low performance. It is deployed to Heroku using the cheapest pricing tier in order to provide dedicated uptime and SSL support. This API is NOT intended to be used at runtime for any reason. As such, it is heavily rate-limited.

Instead, fetch the information you need and store the response, then de-serialize the data for your own application. Or better yet: use the JSON to generate the client-side code you need!

Contributing

If you're looking to provide corrections and/or localizations to any of the data fetched via this API, you can do so by opening an issue or pull request in InstrumentKit.

If you're looking to contribute code to this repository, feel free to open a pull request. The more contributors, the merrier!

Support

If you encounter any problems using API, feel free to open an issue and I'll look into it.

Credits

Special thanks to AudioKit for all of their expertise and support.

License

This project is released under the MIT license. See LICENSE for details.