Curse User Mods API

openapi: 3.2.0
info:
  title: CurseForge Core User Mods API
  description: All endpoints use the same base URL - https://api.curseforge.com
  version: v1
servers:
- url: https://api.curseforge.com
security:
- API_KEY: []
tags:
- name: UserMods
paths:
  /v1/users/me/mods:
    get:
      tags:
      - UserMods
      description: Get the current user's owned and tester mods for the given game key
      operationId: GetUserMods
      parameters:
      - name: index
        in: query
        description: 'A zero based index of the first item to include in the response,  the limit is: (index + pageSize <= 10,000).'
        schema:
          type: integer
          format: int32
        x-position: 1
      - name: pageSize
        in: query
        description: The number of items to include in the response,  the default/maximum value is 50.
        schema:
          type: integer
          format: int32
        x-position: 2
      - name: HasExplicitPageSize
        in: query
        description: 'Whether the caller actually supplied a pageSize, as opposed to

          pageSize returning the default because none was sent. [FromQuery]

          model binding always constructs this class - even from an empty

          query string - so pageSize''s own getter can''t be used to tell those

          two cases apart from outside the class.'
        schema:
          type: boolean
        x-position: 3
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Search_Mods_Response'
        '500':
          description: ''
        '403':
          description: ''
      summary: Get user mods
      x-summary-source: derived
      x-operation-id-source: normalized
      x-operation-id-original: Get User Mods
  /v1/users/me/my-library/search:
    get:
      tags:
      - UserMods
      description: 'Search the current user''s library (purchased/created/testing/trial mods)

        for the given game key, filtered and sorted by the given search parameters'
      operationId: SearchUserLibrary
      parameters:
      - name: gameId
        in: query
        required: true
        description: Filter by game id.
        schema:
          type: integer
          format: int32
        x-position: 1
      - name: classId
        in: query
        description: Filter by section id (discoverable via Categories)
        schema:
          type: integer
          format: int32
        x-position: 2
      - name: categoryId
        in: query
        description: Filter by category id
        schema:
          type: integer
          format: int32
        x-position: 3
      - name: categoryIds
        in: query
        description: "Filter by a list of category ids - this will override categoryId\ncategoryIds=[1,2,3...]\n            \nThe maximum allowed category ids per query is 10"
        schema:
          type: string
        x-position: 4
      - name: gameVersion
        in: query
        description: Filter by game version string
        schema:
          type: string
        x-position: 5
      - name: gameVersions
        in: query
        description: "Filter by a list of game version strings - this will override\ngameVersion\n            \ngameVersions=[\"1.19.1\", \"1.19.2\", \"1.20.1\" ...]\n            \nThe maximum allowed category ids per query is 4"
        schema:
          type: string
        x-position: 6
      - name: searchFilter
        in: query
        description: Filter by free text search in the mod name and author
        schema:
          type: string
        x-position: 7
      - name: sortField
        in: query
        description: Filter by ModsSearchSortField enumeration
        schema:
          $ref: '#/components/schemas/ModsSearchSortField'
        x-position: 8
      - name: sortOrder
        in: query
        description: '''asc'' if sort is in ascending order, ''desc'' if sort is in descending order'
        schema:
          $ref: '#/components/schemas/SortOrder'
        x-position: 9
      - name: modLoaderType
        in: query
        description: Filter only mods associated to a given modloader (Forge, Fabric ...). Must be coupled with gameVersion.
        schema:
          $ref: '#/components/schemas/ModLoaderType'
        x-position: 10
      - name: modLoaderTypes
        in: query
        description: "Filter by a list of mod loader types - this will override modLoaderType\nmodLoaderTypes=[Forge, Fabric, ...]\n            \nMax values = 5"
        schema:
          type: string
        x-position: 11
      - name: gameVersionTypeId
        in: query
        description: Filter only mods that contain files tagged with versions of the given gameVersionTypeId
        schema:
          type:
          - integer
          - 'null'
          format: int32
        x-position: 12
      - name: authorId
        in: query
        description: Filter only mods that the given authorId is a member of.
        schema:
          type:
          - integer
          - 'null'
          format: int32
        x-position: 13
      - name: primaryAuthorId
        in: query
        description: Filter only mods that the given primaryAuthorId is the owner of.
        schema:
          type:
          - integer
          - 'null'
          format: int32
        x-position: 14
      - name: PremiumType
        in: query
        description: Filter only mods that are Premium or not.
        schema:
          $ref: '#/components/schemas/ModPremiumTypeEnum'
        x-position: 15
      - name: slug
        in: query
        description: Filter by slug (coupled with classId will result in a unique result).
        schema:
          type: string
        x-position: 16
      - name: clientCompatible
        in: query
        description: 'When set to true, will filter out any mod that doesn''t have a default

          file that is compatible with the client. This is usually due to a bad

          file structure of the file (which might cause unexpected behaviours on

          the user''s machine - such as overriding other mods installed).'
        schema:
          type: boolean
        x-position: 17
      - name: modsSearchEnhancedFeatures
        in: query
        description: Bitwise number with values from ModsSearchEnhancedFeatures
        schema:
          type: integer
          format: int64
        x-position: 18
      - name: sections
        in: query
        description: Comma delimited list of library sections to include (purchased, created, testing, trial). If omitted, all sections are included.
        schema:
          type: string
        x-position: 19
      - name: index
        in: query
        description: 'A zero based index of the first item to include in the response,  the limit is: (index + pageSize <= 10,000).'
        schema:
          type: integer
          format: int32
        x-position: 20
      - name: pageSize
        in: query
        description: The number of items to include in the response,  the default/maximum value is 50.
        schema:
          type: integer
          format: int32
        x-position: 21
      - name: HasExplicitPageSize
        in: query
        description: 'Whether the caller actually supplied a pageSize, as opposed to

          pageSize returning the default because none was sent. [FromQuery]

          model binding always constructs this class - even from an empty

          query string - so pageSize''s own getter can''t be used to tell those

          two cases apart from outside the class.'
        schema:
          type: boolean
        x-position: 22
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseWithPaginationOfDictionaryOfStringAndListOfMod'
        '500':
          description: ''
        '400':
          description: ''
        '403':
          description: ''
      summary: Search user library
      x-summary-source: derived
      x-operation-id-source: normalized
      x-operation-id-original: Search User Library
components:
  schemas:
    ModPremiumTypeEnum:
      type: integer
      description: '0 = All

        1 = Premium

        2 = Free'
      x-enumNames:
      - All
      - Premium
      - Free
      enum:
      - 0
      - 1
      - 2
    RatingScore:
      type: integer
      description: '0 = NotEnoughReviews

        1 = OverwhelminglyPositive

        2 = VeryPositive

        3 = Positive

        4 = MostlyPositive

        5 = Mixed

        6 = MostlyNegative

        7 = Negative

        8 = VeryNegative

        9 = OverwhelminglyNegative'
      x-enumNames:
      - NotEnoughReviews
      - OverwhelminglyPositive
      - VeryPositive
      - Positive
      - MostlyPositive
      - Mixed
      - MostlyNegative
      - Negative
      - VeryNegative
      - OverwhelminglyNegative
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
    FileIndex:
      type: object
      additionalProperties: false
      properties:
        gameVersion:
          type: string
        fileId:
          type: integer
          format: int32
        filename:
          type: string
        releaseType:
          $ref: '#/components/schemas/FileReleaseType'
        gameVersionTypeId:
          type:
          - integer
          - 'null'
          format: int32
        modLoader:
          $ref: '#/components/schemas/ModLoaderType'
    FileModule:
      type: object
      additionalProperties: false
      properties:
        name:
          type: string
        fingerprint:
          type: integer
          format: int64
    UserTierInfo:
      type: object
      additionalProperties: false
      properties:
        tierLevel:
          type: integer
          format: int32
        downloadsThreshold:
          type: integer
          format: int32
    ModsSearchSortField:
      type: integer
      description: '1 = Featured

        2 = Popularity

        3 = LastUpdated

        4 = Name

        5 = Author

        6 = TotalDownloads

        7 = Category

        8 = GameVersion

        9 = EarlyAccess

        10 = FeaturedReleased

        11 = ReleasedDate

        12 = Rating

        13 = Relevancy'
      x-enumNames:
      - Featured
      - Popularity
      - LastUpdated
      - Name
      - Author
      - TotalDownloads
      - Category
      - GameVersion
      - EarlyAccess
      - FeaturedReleased
      - ReleasedDate
      - Rating
      - Relevancy
      enum:
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      - 11
      - 12
      - 13
    CookerInfo:
      type: object
      additionalProperties: false
      properties:
        cookerVersion:
          type: string
        cookerRevision:
          type: string
    FileReleaseType:
      type: integer
      description: '1 = Release

        2 = Beta

        3 = Alpha'
      x-enumNames:
      - Release
      - Beta
      - Alpha
      enum:
      - 1
      - 2
      - 3
    GalleryItem:
      type: object
      additionalProperties: false
      properties:
        description:
          type: string
        isFeatured:
          type: boolean
        displayIndex:
          type:
          - integer
          - 'null'
          format: int32
        title:
          type: string
        url:
          type: string
        thumbnailUrl:
          type: string
        type:
          $ref: '#/components/schemas/GalleryItemType'
    ApiResponseWithPaginationOfDictionaryOfStringAndListOfMod:
      type: object
      additionalProperties: false
      properties:
        data:
          type: object
          description: The response data
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/Mod'
        pagination:
          description: The response pagination information
          $ref: '#/components/schemas/Pagination'
    ServerAffiliation:
      type: object
      additionalProperties: false
      properties:
        isEnabled:
          type: boolean
        isDefaultBanner:
          type: boolean
        hasDiscount:
          type: boolean
        affiliationService:
          $ref: '#/components/schemas/AffiliationServiceType'
        defaultBannerCustomTitle:
          type: string
        customImageUrl:
          type: string
        affiliationLink:
          type: string
    HashAlgo:
      type: integer
      description: '1 = Sha1

        2 = Md5'
      x-enumNames:
      - Sha1
      - Md5
      enum:
      - 1
      - 2
    SortOrder:
      type: string
      description: ''
      x-enumNames:
      - asc
      - desc
      enum:
      - asc
      - desc
    Search_Mods_Response:
      type: object
      additionalProperties: false
      properties:
        data:
          type: array
          description: The response data
          items:
            $ref: '#/components/schemas/Mod'
        pagination:
          description: The response pagination information
          $ref: '#/components/schemas/Pagination'
    RatingDetails:
      type: object
      additionalProperties: false
      properties:
        rating:
          type:
          - number
          - 'null'
          format: decimal
        totalRatings:
          type:
          - integer
          - 'null'
          format: int32
        positiveRatings:
          type:
          - integer
          - 'null'
          format: int32
        score:
          $ref: '#/components/schemas/RatingScore'
    SocialLink:
      type: object
      additionalProperties: false
      properties:
        type:
          $ref: '#/components/schemas/SocialLinkType'
        url:
          type: string
    ModStatus:
      type: integer
      description: '1 = New

        2 = ChangesRequired

        3 = UnderSoftReview

        4 = Approved

        5 = Rejected

        6 = ChangesMade

        7 = Inactive

        8 = Abandoned

        9 = Deleted

        10 = UnderReview'
      x-enumNames:
      - New
      - ChangesRequired
      - UnderSoftReview
      - Approved
      - Rejected
      - ChangesMade
      - Inactive
      - Abandoned
      - Deleted
      - UnderReview
      enum:
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
    AffiliationServiceType:
      type: integer
      description: 1 = Bisect
      x-enumNames:
      - Bisect
      enum:
      - 1
    SocialLinkType:
      type: integer
      description: '1 = Mastodon

        2 = Discord

        3 = Website

        4 = Facebook

        5 = Twitter

        6 = Instagram

        7 = Patreon

        8 = Twitch

        9 = Reddit

        10 = Youtube

        11 = TikTok

        12 = Pinterest

        13 = Github

        14 = Bsky

        15 = Paypal

        16 = PaypalHosted

        17 = GithubSponsors

        18 = Kofi

        19 = BuyMeACoffee'
      x-enumNames:
      - Mastodon
      - Discord
      - Website
      - Facebook
      - Twitter
      - Instagram
      - Patreon
      - Twitch
      - Reddit
      - Youtube
      - TikTok
      - Pinterest
      - Github
      - Bsky
      - Paypal
      - PaypalHosted
      - GithubSponsors
      - Kofi
      - BuyMeACoffee
      enum:
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      - 11
      - 12
      - 13
      - 14
      - 15
      - 16
      - 17
      - 18
      - 19
    GalleryItemType:
      type: integer
      description: '0 = None

        1 = Screenshot

        2 = EmbeddedVideo'
      x-enumNames:
      - None
      - Screenshot
      - EmbeddedVideo
      enum:
      - 0
      - 1
      - 2
    ModAuthor:
      type: object
      additionalProperties: false
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        url:
          type: string
        avatarUrl:
          type: string
        userTierInfo:
          $ref: '#/components/schemas/UserTierInfo'
    FileStatus:
      type: integer
      description: '1 = Processing

        2 = ChangesRequired

        3 = UnderReview

        4 = Approved

        5 = Rejected

        6 = MalwareDetected

        7 = Deleted

        8 = Archived

        9 = Testing

        10 = Released

        11 = ReadyForReview

        12 = Deprecated

        13 = Baking

        14 = AwaitingPublishing

        15 = FailedPublishing'
      x-enumNames:
      - Processing
      - ChangesRequired
      - UnderReview
      - Approved
      - Rejected
      - MalwareDetected
      - Deleted
      - Archived
      - Testing
      - Released
      - ReadyForReview
      - Deprecated
      - Baking
      - AwaitingPublishing
      - FailedPublishing
      enum:
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      - 11
      - 12
      - 13
      - 14
      - 15
    Category:
      type: object
      additionalProperties: false
      properties:
        id:
          type: integer
          description: The category id
          format: int32
        gameId:
          type: integer
          description: The game id related to the category
          format: int32
        name:
          type: string
          description: Category name
        slug:
          type: string
          description: The category slug as it appear in the URL
        url:
          type: string
          description: The category URL
        iconUrl:
          type: string
          description: URL for the category icon
        dateModified:
          type: string
          description: Last modified date of the category
          format: date-time
        isClass:
          type:
          - boolean
          - 'null'
          description: A top level category for other categories
        classId:
          type:
          - integer
          - 'null'
          description: The class id of the category, meaning - the class of which this category is under
          format: int32
        parentCategoryId:
          type:
          - integer
          - 'null'
          description: The parent category for this category
          format: int32
        displayIndex:
          type:
          - integer
          - 'null'
          description: The display index for this category
          format: int32
    ModLinks:
      type: object
      additionalProperties: false
      properties:
        websiteUrl:
          type: string
        wikiUrl:
          type: string
        issuesUrl:
          type: string
        sourceUrl:
          type: string
    FileHash:
      type: object
      additionalProperties: false
      properties:
        value:
          type: string
        algo:
          $ref: '#/components/schemas/HashAlgo'
    ModAsset:
      type: object
      additionalProperties: false
      properties:
        id:
          type: integer
          format: int32
        modId:
          type: integer
          format: int32
        title:
          type: string
        description:
          type: string
        thumbnailUrl:
          type: string
        url:
          type: string
    FileRelationType:
      type: integer
      description: '1 = EmbeddedLibrary

        2 = OptionalDependency

        3 = RequiredDependency

        4 = Tool

        5 = Incompatible

        6 = Include'
      x-enumNames:
      - EmbeddedLibrary
      - OptionalDependency
      - RequiredDependency
      - Tool
      - Incompatible
      - Include
      enum:
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
    ModLoaderType:
      type: integer
      description: '0 = Any

        1 = Forge

        2 = Cauldron

        3 = LiteLoader

        4 = Fabric

        5 = Quilt

        6 = NeoForge'
      x-enumNames:
      - Any
      - Forge
      - Cauldron
      - LiteLoader
      - Fabric
      - Quilt
      - NeoForge
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
    ClientFeaturedProjectTag:
      type: integer
      description: '0 = None

        1 = Sponsored

        2 = HiddenGem

        3 = Popular'
      x-enumNames:
      - None
      - Sponsored
      - HiddenGem
      - Popular
      enum:
      - 0
      - 1
      - 2
      - 3
    Mod:
      type: object
      additionalProperties: false
      properties:
        id:
          type: integer
          description: The mod id
          format: int32
        gameId:
          type: integer
          description: The game id this mod is for
          format: int32
        name:
          type: string
          description: The name of the mod
        slug:
          type: string
          description: The mod slug that would appear in the URL
        links:
          description: Relevant links for the mod such as Issue tracker and Wiki
          $ref: '#/components/schemas/ModLinks'
        summary:
          type: string
          description: Mod summary
        status:
          description: Current mod status
          $ref: '#/components/schemas/ModStatus'
        downloadCount:
          type: integer
          description: Number of downloads for the mod
          format: int64
        isFeatured:
          type: boolean
          description: Whether the mod is included in the featured mods list
        primaryCategoryId:
          type: integer
          description: The main category of the mod as it was chosen by the mod author
          format: int32
        categories:
          type: array
          description: List of categories that this mod is related to
          items:
            $ref: '#/components/schemas/Category'
        classId:
          type:
          - integer
          - 'null'
          description: The class id this mod belongs to
          format: int32
        authors:
          type: array
          description: List of the mod's authors
          items:
            $ref: '#/components/schemas/ModAuthor'
        logo:
          description: The mod's logo asset
          $ref: '#/components/schemas/ModAsset'
        screenshots:
          type: array
          description: List of screenshots assets
          items:
            $ref: '#/components/schemas/ModAsset'
        videos:
          type: array
          description: List of videos assets
          items:
            $ref: '#/components/schemas/ModAsset'
        mainFileId:
          type: integer
          description: The id of the main file of the mod
          format: int32
        latestFiles:
          type: array
          description: List of latest files of the mod
          items:
            $ref: '#/components/schemas/File'
        latestFilesIndexes:
          type: array
          description: List of file related details for the latest files of the mod
          items:
            $ref: '#/components/schemas/FileIndex'
        latestEarlyAccessFilesIndexes:
          type: array
          description: List of file related details for the latest early access files of the mod
          items:
            $ref: '#/components/schemas/FileIndex'
        dateCreated:
          type: string
          description: The creation date of the mod
          format: date-time
        dateModified:
          type: string
          description: The last time the mod was modified
          format: date-time
        dateReleased:
          type: string
          description: The release date of the mod
          format: date-time
        dateLastReleasedFile:
          type:
          - string
          - 'null'
          description: The last file release date
          format: date-time
        allowModDistribution:
          type:
          - boolean
          - 'null'
          description: Is mod allowed to be distributed
        gamePopularityRank:
          type: integer
          description: The mod popularity rank for the game
          format: int32
        isAvailable:
          type: boolean
          description: Is the mod available for search. This can be false when a mod is experimental, in a deleted state or has only alpha files
        hasCommentsEnabled:
          type:
          - boolean
          - 'null'
          description: Does the mod enable comments
        thumbsUpCount:
          type: integer
          description: The mod's thumbs up count
          format: int32
        ratingDetails:
          description: The mod's Rating Details
          $ref: '#/components/schemas/RatingDetails'
        serverAffiliation:
          description: The mod's server affiliation details
          $ref: '#/components/schemas/ServerAffiliation'
        socialLinks:
          type: array
          description: The mod's social links
          items:
            $ref: '#/components/schemas/SocialLink'
        galleryItems:
          type: array
          description: The mod's gallery items
          items:
            $ref: '#/components/schemas/GalleryItem'
        featuredProjectTag:
          $ref: '#/components/schemas/ClientFeaturedProjectTag'
    File:
      type: object
      additionalProperties: false
      properties:
        id:
          type: integer
          description: The file id
          format: int32
        gameId:
          type: integer
          description: The game id related to the mod that this file belongs to
          format: int32
        modId:
          type: integer
          description: The mod id
          format: int32
        isAvailable:
          type: boolean
          description: Whether the file is available to download
        displayName:
          type: string
          description: Display name of the file
        fileName:
          type: string
          description: Exact file name
        releaseType:
          description: The file release type
          $ref: '#/components/schemas/FileReleaseType'
        fileStatus:
          description: Status of the file
          $ref: '#/components/schemas/FileStatus'
        hashes:
          type: array
          description: The file hash (i.e. md5 or sha1)
          items:
            $ref: '#/components/schemas/FileHash'
        fileDate:
          type: string
          description: The file timestamp
          format: date-time
        fileLength:
          type: integer
          description: The file length in bytes
          format: int64
        downloadCount:
          type: integer
          description: The number of downloads for the file
          format: int64
        fileSizeOnDisk:
          type:
          - integer
          - 'null'
          description: The file's size on disk
          format: int64
        downloadUrl:
          type: string
          description: The file download URL
        gameVersions:
          type: array
          description: List of game versions this file is relevant for
          items:
            type: string
        sortableGameVersions:
          type: array
          description: Metadata used for sorting by game versions
          items:
            $ref: '#/components/schemas/SortableGameVersion'
        dependencies:
          type: array
          description: List of dependencies files
          items:
            $ref: '#/components/schemas/FileDependency'
        exposeAsAlternative:
          type:
          - boolean
          - 'null'
        parentProjectFileId:
          type:
          - integer
          - 'null'
          format: int32
        alternateFileId:
          type:
          - integer
          - 'null'
          format: int32
        isServerPack:
          type:
          - boolean
          - 'null'
        serverPackFileId:
          type:
          - integer
          - 'null'
          format: int32
        isEarlyAccessContent:
          type:
          - boolean
          - 'null'
        earlyAccessEndDate:
          type:
          - string
          - 'null'
          format: date-time
        fileFingerprint:
          type: integer
          format: int64
        modules:
          type: array
          items:
            $ref: '#/components/schemas/FileModule'
        cookingInfo:
          $ref: '#/components/schemas/CookerInfo'
    SortableGameVersion:
      type: object
      additionalProperties: false
      properties:
        gameVersionName:
          type: string
          description: Original version name (e.g. 1.5b)
        gameVersionPadded:
          type: string
          description: Used for sorting (e.g. 0000000001.0000000005)
        gameVersion:
          type: string
          description: game version clean name (e.g. 1.5)
        gameVersionReleaseDate:
          type: string
          description: Game version release date
          format: date-time
        gameVersionTypeId:
          type:
          - integer
          - 'null'
          description: Game version type id
          format: int32
    Pagination:
      type: object
      additionalProperties: false
      properties:
        index:
          type: integer
          description: A zero based index of the first item that is included in the response
          format: int32
        pageSize:
          type: integer
          description: The requested number of items to be included in the response
          format: int32
        resultCount:
          type: integer
          description: The actual number of items that were included in the response
          format: int32
        totalCount:
          type: integer
          description: The total number of items available by the request
          format: int64
    FileDependency:
      type: object
      additionalProperties: false
      properties:
        modId:
          type: integer
          format: int32
        relationType:
          $ref: '#/components/schemas/FileRelationType'
  securitySchemes:
    API_KEY:
      type: apiKey
      description: <br/>The API key can be generated in the CurseForge for Studios [developer console](https://console.curseforge.com/).
      name: x-api-key
      in: header
x-generator: NSwag v13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))
x-provenance:
  method: harvested
  publisher: Curse
  source: https://api.curseforge.com/swagger/v1/swagger.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)