openapi2.yaml

swagger: '2.0'
openapi: '3.0'
info:
  title: Chimu API
  version: ''
  description: |-
    ## API V1
    Spec file you can find [here](https://api.chimu.moe/docs/swagger.json)
    #### If you find some mistake in API, please notify ASAP administration in our [discord](https://discord.com/invite/9JnqPSrPpz) channel!
host: api.chimu.moe
basePath: /
schemes:
  - https
paths:
  /v1/map/{map_id}:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          examples:
            application/json:
              BeatmapId: 53
              ParentSetId: 3
              DiffName: '-Crusin-'
              FileMD5: 1d23c37a2fda439be752ae2bca06c0cd
              Mode: 0
              BPM: 172
              AR: 4
              OD: 4
              CS: 5
              HP: 3
              TotalLength: 83
              HitLength: 77
              Playcount: 101574
              Passcount: 47994
              MaxCombo: 124
              DifficultyRating: 1.86918
              OsuFile: Ni-Ni - 1,2,3,4, 007 [Wipeout Series] (MCXD) [-Crusin-].osu
              DownloadPath: /d/3
        '400':
          description: Bad Request
          headers: {}
          examples:
            application/json:
              error_message: One of the query values isn't correct, please check your encoding settings
              error_code: oneOfQueryIsntCorrect
        '404':
          description: Not Found
          headers: {}
          examples:
            application/json:
              error_message: Map not found, please try to search another one :/
              error_code: map_not_found
      summary: Get beatmap
      operationId: Get beatmap
      description: |-
        Gets a beatmap.
        if it fails it returns a simple JSON Serialized error including
        a message and error code.
      tags: ['Chimu API']
      parameters:
        - name: map_id
          in: path
          description: Beatmap Id
          required: true
          x-example: '53'
          type: number
      produces:
        - application/json
  /v1/set/{set_id}:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          examples:
            application/json:
              SetId: 1
              ChildrenBeatmaps:
                - BeatmapId: 75
                  ParentSetId: 1
                  DiffName: Normal
                  FileMD5: a5b99395a42bd55bc5eb1d2411cbdf8b
                  Mode: 0
                  BPM: 119.999
                  AR: 6
                  OD: 6
                  CS: 4
                  HP: 6
                  TotalLength: 142
                  HitLength: 109
                  Playcount: 467474
                  Passcount: 57119
                  MaxCombo: 314
                  DifficultyRating: 2.40729
                  OsuFile: Kenji Ninuma - DISCO PRINCE (peppy) [Normal].osu
                  DownloadPath: /d/1
              RankedStatus: 1
              ApprovedDate: '2007-10-06T17:46:31'
              LastUpdate: '2007-10-06T17:46:31'
              LastChecked: '2021-01-19T09:43:57'
              Artist: Kenji Ninuma
              Title: DISCO PRINCE
              Creator: peppy
              Source: ''
              Tags: katamari
              HasVideo: false
              Genre: 2
              Language: 3
              Favourites: 789
              Disabled: false
        '400':
          description: Bad Request
          headers: {}
          examples:
            application/json:
              error_message: One of the query values isn't correct, please check your encoding settings
              error_code: oneOfQueryIsntCorrect
        '404':
          description: Not Found
          headers: {}
          examples:
            application/json:
              error_message: Set not found, please try to search another one :/
              error_code: set_not_found
      summary: Get beatmap set
      operationId: Get beatmap set
      description: |-
        Gets a beatmap set.
        if it fails it returns a simple JSON Serialized error including
        a message and error code.
      tags: ['Chimu API']
      parameters:
        - name: set_id
          in: path
          description: Beatmap set Id
          required: true
          x-example: '1'
          type: number
      produces:
        - application/json
  /v1/download/{set_id}:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          examples:
            application/octet-stream: ''
        '404':
          description: Not Found
          headers: {}
          examples:
            application/json:
              error_message: Set not found, please try to search another one :/
              error_code: set_not_found
        '500':
          description: |-
            Internal Server Error
            Error code have variety, as unknown_error, cant_download_map
          headers: {}
          examples:
            application/json:
              error_message: >-
                Something strange happend on our systems, please notify
                about this on our Discord channel :<
              error_code: server_error
      summary: Download beatmap set
      operationId: Download beatmap set
      description: |-
        Downloads a beatmap set using given set id</br>
        <i>NOTE:</i> Chimu currently responses only with noVideo maps!
      tags: ['Chimu API']
      parameters:
        - name: set_id
          in: path
          description: Beatmap set Id
          required: true
          x-example: '1'
          type: number
      produces:
        - application/octet-stream
        - application/json
  /v1/search:
    get:
      responses:
        '500':
          description: Internal Server Error
          headers: {}
          examples:
            application/json:
              error_message: >-
                Something strange happend on our systems, please notify
                about this on our Discord channel :<
              error_code: server_error
        '200':
          description: OK
          headers: {}
          examples:
            application/json:
              data: 
                - SetId: 1
                  ChildrenBeatmaps:
                    - BeatmapId: 75
                      ParentSetId: 1
                      DiffName: Normal
                      FileMD5: a5b99395a42bd55bc5eb1d2411cbdf8b
                      Mode: 0
                      BPM: 119.999
                      AR: 6
                      OD: 6
                      CS: 4
                      HP: 6
                      TotalLength: 142
                      HitLength: 109
                      Playcount: 467474
                      Passcount: 57119
                      MaxCombo: 314
                      DifficultyRating: 2.40729
                      OsuFile: Kenji Ninuma - DISCO PRINCE (peppy) [Normal].osu
                      DownloadPath: /d/1
                  RankedStatus: 1
                  ApprovedDate: '2007-10-06T17:46:31'
                  LastUpdate: '2007-10-06T17:46:31'
                  LastChecked: '2021-01-19T09:43:57'
                  Artist: Kenji Ninuma
                  Title: DISCO PRINCE
                  Creator: peppy
                  Source: ''
                  Tags: katamari
                  HasVideo: false
                  Genre: 2
                  Language: 3
                  Favourites: 789
                  Disabled: false
      summary: Search
      operationId: Search
      description: Search for a beatmap set
      tags: ['Chimu API']
      parameters:
        - name: query
          in: query
          description: Search query
          required: false
          x-example: peppy
          type: string
        - name: amount
          in: query
          description: Amount of resulting beatmaps
          required: false
          x-example: '100'
          type: number
        - name: offset
          in: query
          description: Offset E.G amount + 100 would result in the next page
          required: false
          x-example: '0'
          type: number
        - name: status
          in: query
          description: Ranked statuses of the Beatmap Set
          required: false
          x-example: '0'
          type: string
        - name: mode
          in: query
          description: Required playmodes of the beatmap
          required: false
          x-example: '0'
          type: string
        - name: min_ar
          in: query
          description: Minimum AR
          required: false
          x-example: '0'
          type: number
        - name: max_ar
          in: query
          description: Maximum AR
          required: false
          x-example: '0'
          type: number
        - name: min_od
          in: query
          description: Minimum OD
          required: false
          x-example: '0'
          type: number
        - name: max_od
          in: query
          description: Maximum OD
          required: false
          x-example: '0'
          type: number
        - name: min_cs
          in: query
          description: Minimum CS
          required: false
          x-example: '0'
          type: number
        - name: max_cs
          in: query
          description: Maximum CS
          required: false
          x-example: '0'
          type: number
        - name: min_hp
          in: query
          description: Minimum HP
          required: false
          x-example: '0'
          type: number
        - name: max_hp
          in: query
          description: Maximum HP
          required: false
          x-example: '0'
          type: number
        - name: min_diff
          in: query
          description: Minimum Difficulty
          required: false
          x-example: '0'
          type: number
        - name: max_diff
          in: query
          description: Maximum Difficulty
          required: false
          x-example: '0'
          type: number
        - name: min_bpm
          in: query
          description: Minimum BPM
          required: false
          x-example: '0'
          type: number
        - name: max_bpm
          in: query
          description: Maximum BPM
          required: false
          x-example: '0'
          type: number
        - name: min_length
          in: query
          description: Minimum Beatmap length (in seconds)
          required: false
          x-example: '0'
          type: number
        - name: max_length
          in: query
          description: Maximum Beatmap length (in seconds)
          required: false
          x-example: '0'
          type: number
        - name: genre
          in: query
          description: Genre
          required: false
          x-example: '0'
          type: number
        - name: language
          in: query
          description: Language
          required: false
          x-example: '0'
          type: number
      produces:
        - application/json
  /cheesegull/b/{map_id}:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          examples:
            application/json:
              BeatmapID: 53
              ParentSetID: 3
              DiffName: '-Crusin-'
              FileMD5: 1d23c37a2fda439be752ae2bca06c0cd
              Mode: 0
              BPM: 172
              AR: 4
              OD: 4
              CS: 5
              HP: 3
              TotalLength: 83
              HitLength: 77
              Playcount: 101574
              Passcount: 47994
              MaxCombo: 124
              DifficultyRating: 1.86918
        '400':
          description: Bad Request
          headers: {}
          examples:
            application/json:
              error_message: One of the query values isn't correct, please check your encoding settings
              error_code: oneOfQueryIsntCorrect
        '404':
          description: Not Found
          headers: {}
          examples:
            application/json:
              error_message: Map not found, please try to search another one :/
              error_code: map_not_found
      summary: Cheesegull> Get beatmap
      operationId: Cheesegull> Get beatmap
      description: Gets a beatmap.
      tags: ['Cheesegull API']
      parameters:
        - name: map_id
          in: path
          description: Beatmap Id
          required: true
          x-example: '53'
          type: number
      produces:
        - application/json
  /cheesegull/md5/{map_md5}:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          examples:
            application/json:
              BeatmapID: 53
              ParentSetID: 3
              DiffName: '-Crusin-'
              FileMD5: 1d23c37a2fda439be752ae2bca06c0cd
              Mode: 0
              BPM: 172
              AR: 4
              OD: 4
              CS: 5
              HP: 3
              TotalLength: 83
              HitLength: 77
              Playcount: 101574
              Passcount: 47994
              MaxCombo: 124
              DifficultyRating: 1.86918
        '400':
          description: Bad Request
          headers: {}
          examples:
            application/json:
              error_message: One of the query values isn't correct, please check your encoding settings
              error_code: oneOfQueryIsntCorrect
        '404':
          description: Not Found
          headers: {}
          examples:
            application/json:
              error_message: Map not found, please try to search another one :/
              error_code: map_not_found
      summary: Cheesegull> Get beatmap
      operationId: Cheesegull> Get beatmap
      description: Gets a beatmap with specified md5 hash.
      tags: ['Cheesegull API']
      parameters:
        - name: map_md5
          in: path
          description: Beatmap md5
          required: true
          x-example: 1d23c37a2fda439be752ae2bca06c0cd
          type: string
      produces:
        - application/json
  /cheesegull/s/{set_id}:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          examples:
            application/json:
              SetID: 1
              ChildrenBeatmaps:
                - BeatmapID: 75
                  ParentSetID: 1
                  DiffName: Normal
                  FileMD5: a5b99395a42bd55bc5eb1d2411cbdf8b
                  Mode: 0
                  BPM: 119.999
                  AR: 6
                  OD: 6
                  CS: 4
                  HP: 6
                  TotalLength: 142
                  HitLength: 109
                  Playcount: 467474
                  Passcount: 57119
                  MaxCombo: 314
                  DifficultyRating: 2.40729
              RankedStatus: 1
              ApprovedDate: '2007-10-06T17:46:31Z'
              LastUpdate: '2007-10-06T17:46:31Z'
              LastChecked: '2021-01-19T09:43:57Z'
              Artist: Kenji Ninuma
              Title: DISCO PRINCE
              Creator: peppy
              Source: ''
              Tags: katamari
              HasVideo: false
              Genre: 2
              Language: 3
              Favourites: 789
        '400':
          description: Bad Request
          headers: {}
          examples:
            application/json:
              error_message: One of the query values isn't correct, please check your encoding settings
              error_code: oneOfQueryIsntCorrect
        '404':
          description: Not Found
          headers: {}
          examples:
            application/json:
              error_message: Set not found, please try to search another one :/
              error_code: set_not_found
      summary: Cheesegull> Get beatmapset
      operationId: Cheesegull> Get beatmapset
      description: Gets a beatmap set.
      tags: ['Cheesegull API']
      parameters:
        - name: set_id
          in: path
          description: Beatmapset Id
          required: true
          x-example: '1'
          type: number
      produces:
        - application/json
  /cheesegull/search:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          examples:
            application/json:
              - SetID: 1
                ChildrenBeatmaps:
                  - BeatmapID: 75
                    ParentSetID: 1
                    DiffName: Normal
                    FileMD5: a5b99395a42bd55bc5eb1d2411cbdf8b
                    Mode: 0
                    BPM: 119.999
                    AR: 6
                    OD: 6
                    CS: 4
                    HP: 6
                    TotalLength: 142
                    HitLength: 109
                    Playcount: 467474
                    Passcount: 57119
                    MaxCombo: 314
                    DifficultyRating: 2.40729
                RankedStatus: 1
                ApprovedDate: '2007-10-06T17:46:31Z'
                LastUpdate: '2007-10-06T17:46:31Z'
                LastChecked: '2021-01-19T09:43:57Z'
                Artist: Kenji Ninuma
                Title: DISCO PRINCE
                Creator: peppy
                Source: ''
                Tags: katamari
                HasVideo: false
                Genre: 2
                Language: 3
                Favourites: 789
      summary: Cheesegull> Search
      operationId: Cheesegull> Search
      description: Search for a beatmap set
      tags: ['Cheesegull API']
      parameters:
        - name: query
          in: query
          description: Search query
          required: false
          x-example: peppy disco
          type: string
        - name: amount
          in: query
          description: Amount of resulting beatmaps
          required: false
          x-example: '1'
          type: number
        - name: offset
          in: query
          description: Offset E.G amount + 100 would result in the next page
          required: false
          x-example: '0'
          type: number
        - name: status
          in: query
          description: Ranked statuses of the Beatmap Set
          required: false
          x-example: '0'
          type: string
        - name: mode
          in: query
          description: Required playmodes of the beatmap
          required: false
          x-example: '0'
          type: string
      produces:
        - application/json
# definitions:
#   Get beatmap: {}
#   Get beatmap set: {}
#   Download beatmap set: {}
#   Search: {}
#   Cheesegull> Get beatmap: {}
#   Cheesegull> Get beatmapset: {}
#   Cheesegull> Search: {}
securityDefinitions: {}
tags: ['Chimu API', 'Cheesegull API']