openapi: 3.2.0
info:
  title: Open Food Facts Open Suggestions API
  description: 'As a developer, the Open Food Facts API allows you to get information

    and contribute to the products database. You can create great apps to

    help people make better food choices and also provide data to enhance the database.


    **IMPORTANT**: Please read the API introduction before using this API.'
  termsOfService: https://world.openfoodfacts.org/terms-of-use
  contact:
    name: Open Food Facts
    url: https://slack.openfoodfacts.org/
    email: reuse@openfoodfacts.org
  license:
    name: 'data: ODbL'
    url: https://opendatacommons.org/licenses/odbl/summary/index.html
    x-identifier: ODbL-1.0
  version: '2'
servers:
- description: dev
  url: https://world.openfoodfacts.net
- description: prod
  url: https://world.openfoodfacts.org
- description: proxy (for doc purpose)
  url: http://localhost:8080
security:
- userAgentAuth: []
tags:
- name: Suggestions
  description: Endpoints for getting suggestions to aid in product editing.
paths:
  /cgi/suggest.pl:
    get:
      summary: Get Suggestions
      tags:
      - Suggestions
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
      operationId: get-cgi-suggest.pl
      parameters:
      - name: tagtype
        in: query
        description: Type of a tag / id of a tags taxonomy (e.g. categories, labels, ingredients, etc.)
        required: true
        schema:
          type: string
          example: additives
      - $ref: '#/components/parameters/term'
      description: 'For example , Dave is looking for packaging_shapes that contain the term "fe",

        all packaging_shapes containing "fe" will be returned.

        This is useful if you have a search in your application,

        for a specific product field.'
components:
  parameters:
    term:
      schema:
        type: string
        example: f
      in: query
      name: term
  securitySchemes:
    cookieAuth:
      type: apiKey
      in: cookie
      name: session
      description: 'Session cookie containing user ID, username, and session token.

        The value is structured as: user_id&username&user_session&session_token

        e.g. "user_id&exampleuser&user_session&abcdefghijklmnopqrstuvwxyz123456789ABCDEFGHIJKLM".

        The session token is obtained after successful login via the `/cgi/session.pl` endpoint.

        '
    userAgentAuth:
      description: Identification using the User-Agent header. This is recommended in all requests so that we can contact you if there are issues. If we cannot identify the source of problematic API queries, we may have to block them. User-Agent header in the format 'app_name/app_version (URL or contact info)'
      type: apiKey
      in: header
      name: User-Agent
externalDocs:
  description: '**IMPORTANT**: Please read the API introduction before using this API.

    '
  url: https://openfoodfacts.github.io/openfoodfacts-server/api/