Wger Ingredient API

openapi: 3.2.0
info:
  title: wger Ingredient API
  version: 2.7.0a2
  description: Self hosted FLOSS workout and fitness tracker.
  license:
    name: AGPL-3.0-or-later
    url: https://www.gnu.org/licenses/agpl-3.0.html
servers:
- url: /
  description: This server
- url: https://wger.de
  description: The "official" upstream wger instance
tags:
- name: ingredient
  description: Nutritional information per ingredient, referencing related objects by ID. Read-only and rate limited.
paths:
  /api/v2/ingredient/:
    get:
      operationId: ingredient_list
      description: 'API endpoint for ingredient objects. For a read-only endpoint with all

        the information of an ingredient, see /api/v2/ingredientinfo/'
      parameters:
      - in: query
        name: carbohydrates
        schema:
          type: number
      - in: query
        name: carbohydrates_sugar
        schema:
          type: number
      - in: query
        name: code
        schema:
          type: string
      - in: query
        name: created
        schema:
          type: string
          format: date-time
      - in: query
        name: created__gt
        schema:
          type: string
          format: date-time
      - in: query
        name: created__lt
        schema:
          type: string
          format: date-time
      - in: query
        name: energy
        schema:
          type: integer
      - in: query
        name: fat
        schema:
          type: number
      - in: query
        name: fat_saturated
        schema:
          type: number
      - in: query
        name: fiber
        schema:
          type: number
      - in: query
        name: id
        schema:
          type: integer
      - in: query
        name: id__gt
        schema:
          type: integer
      - in: query
        name: id__gte
        schema:
          type: integer
      - in: query
        name: id__in
        schema:
          type: array
          items:
            type: integer
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: id__lt
        schema:
          type: integer
      - in: query
        name: id__lte
        schema:
          type: integer
      - in: query
        name: is_vegan
        schema:
          type: boolean
      - in: query
        name: is_vegetarian
        schema:
          type: boolean
      - in: query
        name: language
        schema:
          type: integer
      - in: query
        name: language__code
        schema:
          type: string
        description: Filter by language code. Multiple values may be separated by commas. Unknown codes are ignored.
      - in: query
        name: language__in
        schema:
          type: array
          items:
            type: integer
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: last_imported
        schema:
          type: string
          format: date-time
      - in: query
        name: last_imported__gt
        schema:
          type: string
          format: date-time
      - in: query
        name: last_imported__lt
        schema:
          type: string
          format: date-time
      - in: query
        name: last_update
        schema:
          type: string
          format: date-time
      - in: query
        name: last_update__gt
        schema:
          type: string
          format: date-time
      - in: query
        name: last_update__lt
        schema:
          type: string
          format: date-time
      - in: query
        name: license
        schema:
          type: integer
      - in: query
        name: license_author
        schema:
          type: string
      - name: limit
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: name
        schema:
          type: string
      - in: query
        name: name__search
        schema:
          type: string
      - in: query
        name: nutriscore
        schema:
          type:
          - string
          - 'null'
          title: Nutri-Score
          enum:
          - a
          - b
          - c
          - d
          - e
        description: 'Nutri-Score grade from Open Food Facts


          * `a` - A

          * `b` - B

          * `c` - C

          * `d` - D

          * `e` - E'
      - in: query
        name: nutriscore__gt
        schema:
          type: string
      - in: query
        name: nutriscore__gte
        schema:
          type: string
      - in: query
        name: nutriscore__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: nutriscore__lt
        schema:
          type: string
      - in: query
        name: nutriscore__lte
        schema:
          type: string
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - in: query
        name: protein
        schema:
          type: number
      - in: query
        name: sodium
        schema:
          type: number
      - in: query
        name: source_name
        schema:
          type: string
      - in: query
        name: uuid
        schema:
          type: string
          format: uuid
      tags:
      - ingredient
      security:
      - cookieAuth: []
      - tokenAuth: []
      - headlessJwtAuth: []
      - oidcAuth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedIngredientList'
          description: ''
      summary: Ingredient list
      x-summary-source: derived
  /api/v2/ingredient/{id}/:
    get:
      operationId: ingredient_retrieve
      description: 'API endpoint for ingredient objects. For a read-only endpoint with all

        the information of an ingredient, see /api/v2/ingredientinfo/'
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this ingredient.
        required: true
      tags:
      - ingredient
      security:
      - cookieAuth: []
      - tokenAuth: []
      - headlessJwtAuth: []
      - oidcAuth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Ingredient'
          description: ''
      summary: Ingredient retrieve
      x-summary-source: derived
  /api/v2/ingredient/{id}/get_values/:
    get:
      operationId: ingredient_get_values_retrieve
      description: 'Calculates the nutritional values for current ingredient and

        the given amount and unit.


        This function basically just performs a multiplication (in the model), and

        is a candidate to be moved to pure AJAX calls, however doing it like this

        keeps the logic nicely hidden and respects the DRY principle.'
      parameters:
      - in: query
        name: amount
        schema:
          type: number
          format: double
        description: The amount to calculate the values for
        required: true
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this ingredient.
        required: true
      - in: query
        name: unit
        schema:
          type: integer
        description: ID of an ingredient weight unit. Defaults to grams.
      tags:
      - ingredient
      security:
      - cookieAuth: []
      - tokenAuth: []
      - headlessJwtAuth: []
      - oidcAuth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IngredientValues'
          description: ''
      summary: Ingredient get values retrieve
      x-summary-source: derived
components:
  schemas:
    PaginatedIngredientList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?offset=400&limit=100
        previous:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?offset=200&limit=100
        results:
          type: array
          items:
            $ref: '#/components/schemas/Ingredient'
    NullEnum:
      enum:
      - null
    IngredientValues:
      type: object
      description: 'Nutritional values for a given amount and unit of an ingredient.


        Carries the form errors instead of usable values when the amount or unit

        query parameters don''t validate.'
      properties:
        energy:
          type: number
          format: double
        protein:
          type: number
          format: double
        carbohydrates:
          type: number
          format: double
        carbohydrates_sugar:
          type:
          - number
          - 'null'
          format: double
        fat:
          type: number
          format: double
        fat_saturated:
          type:
          - number
          - 'null'
          format: double
        fiber:
          type:
          - number
          - 'null'
          format: double
        sodium:
          type:
          - number
          - 'null'
          format: double
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
      required:
      - carbohydrates
      - carbohydrates_sugar
      - energy
      - fat
      - fat_saturated
      - fiber
      - protein
      - sodium
    NutriscoreEnum:
      enum:
      - a
      - b
      - c
      - d
      - e
      type: string
      description: '* `a` - A

        * `b` - B

        * `c` - C

        * `d` - D

        * `e` - E'
    Ingredient:
      type: object
      description: Ingredient serializer
      properties:
        id:
          type: integer
          readOnly: true
        uuid:
          type: string
          format: uuid
          readOnly: true
        remote_id:
          type:
          - string
          - 'null'
          maxLength: 200
        source_name:
          type:
          - string
          - 'null'
          maxLength: 200
        source_url:
          title: Link
          description: Link to product
          oneOf:
          - type: string
            format: uri
            maxLength: 200
          - type: string
            maxLength: 0
        code:
          type:
          - string
          - 'null'
          maxLength: 200
        name:
          type: string
          maxLength: 200
          minLength: 3
        common_name:
          type:
          - string
          - 'null'
          maxLength: 200
        brand:
          type:
          - string
          - 'null'
          title: Brand name of product
          maxLength: 200
        created:
          type: string
          format: date-time
          readOnly: true
          title: Date
        last_update:
          type: string
          format: date-time
          readOnly: true
          title: Date
        last_imported:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
          title: Date
        energy:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
          description: In kcal per 100g
        protein:
          type: string
          format: decimal
          pattern: ^-?\d{0,3}(?:\.\d{0,3})?$
          description: In g per 100g of product
        carbohydrates:
          type: string
          format: decimal
          pattern: ^-?\d{0,3}(?:\.\d{0,3})?$
          description: In g per 100g of product
        carbohydrates_sugar:
          type:
          - string
          - 'null'
          format: decimal
          pattern: ^-?\d{0,3}(?:\.\d{0,3})?$
          title: Sugar content in carbohydrates
          description: In g per 100g of product
        fat:
          type: string
          format: decimal
          pattern: ^-?\d{0,3}(?:\.\d{0,3})?$
          description: In g per 100g of product
        fat_saturated:
          type:
          - string
          - 'null'
          format: decimal
          pattern: ^-?\d{0,3}(?:\.\d{0,3})?$
          title: Saturated fat content in fats
          description: In g per 100g of product
        fiber:
          type:
          - string
          - 'null'
          format: decimal
          pattern: ^-?\d{0,3}(?:\.\d{0,3})?$
          description: In g per 100g of product
        sodium:
          type:
          - string
          - 'null'
          format: decimal
          pattern: ^-?\d{0,3}(?:\.\d{0,3})?$
          description: In g per 100g of product
        is_vegan:
          type:
          - boolean
          - 'null'
          title: Vegan
          description: Whether the ingredient is suitable for a vegan diet
        is_vegetarian:
          type:
          - boolean
          - 'null'
          title: Vegetarian
          description: Whether the ingredient is suitable for a vegetarian diet
        weight_units:
          type: array
          items:
            $ref: '#/components/schemas/IngredientWeightUnit'
        nutriscore:
          title: Nutri-Score
          description: 'Nutri-Score grade from Open Food Facts


            * `a` - A

            * `b` - B

            * `c` - C

            * `d` - D

            * `e` - E'
          oneOf:
          - $ref: '#/components/schemas/NutriscoreEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        license:
          type: integer
        license_title:
          type: string
          title: The original title of this object, if available
          maxLength: 300
        license_object_url:
          title: Link to original object, if available
          oneOf:
          - type: string
            format: uri
            maxLength: 200
          - type: string
            maxLength: 0
        license_author:
          type: string
          title: Author(s)
          description: If you are not the author, enter the name or source here.
          maxLength: 3500
        license_author_url:
          title: Link to author profile, if available
          oneOf:
          - type: string
            format: uri
            maxLength: 200
          - type: string
            maxLength: 0
        license_derivative_source_url:
          title: Link to the original source, if this is a derivative work
          description: Note that a derivative work is one which is not only based on a previous work, but which also contains sufficient new, creative content to entitle it to its own copyright.
          oneOf:
          - type: string
            format: uri
            maxLength: 200
          - type: string
            maxLength: 0
        language:
          type: integer
          readOnly: true
      required:
      - carbohydrates
      - created
      - energy
      - fat
      - id
      - language
      - last_imported
      - last_update
      - name
      - protein
      - uuid
      - weight_units
    BlankEnum:
      enum:
      - ''
    IngredientWeightUnit:
      type: object
      description: IngredientWeightUnit serializer
      properties:
        id:
          type: integer
          readOnly: true
        uuid:
          type: string
          format: uuid
          readOnly: true
        ingredient:
          type: integer
          readOnly: true
        gram:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
          title: Amount in grams
        name:
          type: string
          maxLength: 200
      required:
      - gram
      - id
      - ingredient
      - name
      - uuid
  securitySchemes:
    cookieAuth:
      type: apiKey
      in: cookie
      name: sessionid
    headlessJwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Access token issued by the allauth headless endpoints
    jwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    oidcAuth:
      type: oauth2
      description: Access token issued by the OAuth2/OIDC provider
      flows:
        authorizationCode:
          authorizationUrl: https://wger.de/identity/o/authorize
          tokenUrl: https://wger.de/identity/o/api/token
          scopes:
            api:read: View your training, nutrition and body data
            api:write: Add and change your training, nutrition and body data
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"
externalDocs:
  url: https://wger.readthedocs.io
  description: wger documentation