Public APIs for use within whatever you want. These are ratelimited, so try to keep requests to a minimum.
Future use of the API will require an API key.
API keys need to be passed alongside every request. With an API key, you are also expected to adhere to the following guidelines: - Do not share your API key. - Data can be retained for a maximum of 30 days (this is to adhere with GDPR guidelines).
API keys can also be saved to the browser for convenience using the client login/logout APIs.
You can obtain an API key by asking staff in the Eclipsis discord.
This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.
org.openapitools.codegen.languages.RustClientCodegenPut the package under your project folder in a directory named eclipsis-rs and add the following to Cargo.toml under [dependencies]:
eclipsis-rs = { path = "./eclipsis-rs" }
All URIs are relative to https://api.xethlyx.com
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- ClientApi | clientdelete | DELETE /client/delete | Delete *ClientApi* | clientinfo | GET /client/info | Info ClientApi | clientlogin | POST /client/login | Login *ClientApi* | clientlogout | POST /client/logout | Logout MatchApi | getmatch | GET /eclipsis/match/{matchId} | Get match data *UserApi* | getuserdelta | GET /eclipsis/user/delta/{userId} | Get rating delta *UserApi* | getusermatches | GET /eclipsis/user/matches/{userId} | Get matches *UserApi* | getuseroverview | GET /eclipsis/user/overview/{userId} | Get overview *UserApi* | getuserplaytime | GET /eclipsis/user/playtime/{userId} | Get playtime *UserApi* | getuserrating | GET /eclipsis/user/rating/{userId} | Get rating *UserApi* | getuserstatus | POST /eclipsis/user/status | Get basic status *UserApi* | getuser_teammates | GET /eclipsis/user/teammates/{userId} | Get teammates
To get access to the crate's generated documentation, use:
cargo doc --open