{"note":"OpenAPI conversion -- returning structured metadata","name":"skynewz-api-fortnite-herokuapp-com","description":"FORTNITE REST API","version":"3.1.5","base_url":"https://skynewz-api-fortnite.herokuapp.com/api","endpoints":9,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api FORTNITE REST API\n@base https://skynewz-api-fortnite.herokuapp.com/api\n@version 3.1.5\n@auth ApiKey Authorization in header\n@endpoints 9\n@toc oauth(1), check(1), news(1), user(1), stats(2), pve(2), store(1)\n\n@group oauth\n@endpoint POST /oauth/token\n@desc Get a Bearer token\n@required {email: any, password: any}\n@returns(200) Your access token\n@errors {401: Authentication failed, 404: Authentication failed. User not found}\n\n@endgroup\n\n@group check\n@endpoint GET /check\n@desc Get Fortnite game status\n@returns(200) Fortnite is okay !\n\n@endgroup\n\n@group news\n@endpoint GET /news\n@desc Get Fortnite News\n@returns(200) A JSON objects of current news\n\n@endgroup\n\n@group user\n@endpoint GET /user/{plateform}/{username}\n@desc Get a user by username\n@required {plateform: any # Playing plateform, can be xb1, ps4 or pc, username: any # Player username}\n@returns(200) JSON Object of user\n@errors {404: User not found or not found on this plateform}\n\n@endgroup\n\n@group stats\n@endpoint GET /stats/{plateform}/{username}\n@desc Get user's stats by username\n@required {plateform: any # Playing plateform, can be xb1, ps4 or pc, username: any # Player username}\n@returns(200) JSON Object of user stats\n@errors {400: Please precise a good platform: ps4/xb1/pc, 404: User not found or not found on this plateform}\n\n@endpoint GET /stats/id/{plateform}/{id}\n@desc Get user's stats by user id\n@required {plateform: any # Playing plateform, can be xb1, ps4 or pc, id: any # Player ID}\n@returns(200) JSON Object of user stats\n@errors {400: Please precise a good platform: ps4/xb1/pc, 404: User not found or not found on this plateform}\n\n@endgroup\n\n@group pve\n@endpoint GET /pve/user/{username}\n@desc Get PVE Stat by given username\n@required {username: any # Fortnite username}\n@returns(200) All okay\n@errors {404: User not found or not found on this plateform}\n\n@endpoint GET /pve/info\n@desc Get Fortnite PVE Info (storm, etc)\n@returns(200) All okay\n\n@endgroup\n\n@group store\n@endpoint GET /store\n@desc Get Fortnite Store\n@returns(200) Current store object\n\n@endgroup\n\n@end\n"}