Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/librescore/mscz-api
HTTP API based on webmscore to manage MSCZ files.
https://github.com/librescore/mscz-api
api http-api midi mscz musescore musicxml sheet-music
Last synced: about 2 months ago
JSON representation
HTTP API based on webmscore to manage MSCZ files.
- Host: GitHub
- URL: https://github.com/librescore/mscz-api
- Owner: LibreScore
- License: gpl-3.0
- Created: 2020-12-11T20:33:34.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2021-04-12T18:09:46.000Z (over 3 years ago)
- Last Synced: 2023-03-06T16:37:35.821Z (almost 2 years ago)
- Topics: api, http-api, midi, mscz, musescore, musicxml, sheet-music
- Language: TypeScript
- Homepage: https://mscz-api.librescore.org/
- Size: 12.2 MB
- Stars: 8
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mscz-api
This is a HTTP API to manage MSCZ files. The public API is at https://mscz-api.librescore.org/. Source code is under the GPLv3.
## Usage
### Rate limits
The rate limit is `100` API calls for ten minutes. An API call is one HTTP request.
### Metadata
The `/meta` path takes a MSCZ file through a post request (`application/x-musescore`).
and sends back a JSON file with metadata.
### Conversion Formats
For conversion, you `POST //`. The available formats are `midi`,
`mxml`, and `mmxl`. It will return the appropriate mime-type for ``.
`` is the ID of the excerpt from the metadata, so a `/meta` request should
be made before conversion. Simply `POST /` for the full score.
### Error codes
| Reason | Code |
| ------ | ------------------------------------------------------------- |
| 400 | Invalid format, invalid instrument, or malformed `mscz` file. |
## Examples
Examples are available in `docs/examples`, with an mscz file, its metadata, and the
various conversions for that file. All files there were converted with the API. Providing
mscz files to convert would help. `GeneralUser Orchestral Example` provided by Generaluser GS.