@openfoodfacts/openfoodfacts-nodejs
    Preparing search index...

    Class PricesApi

    Index

    Constructors

    constructor

    Methods

    createPrice getPrices getProofs getStatus isAuthenticated login uploadProof

    Constructors

    • Parameters

      • fetch: (input: RequestInfo | URL, init?: RequestInit) => Promise<Response> & {
            (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
            (input: string | Request | URL, init?: RequestInit): Promise<Response>;
        }
          • (input: RequestInfo | URL, init?: RequestInit): Promise<Response>

          • MDN Reference

            Parameters

            • input: RequestInfo | URL
            • Optionalinit: RequestInit

            Returns Promise<Response>

          • (input: RequestInfo | URL, init?: RequestInit): Promise<Response>

          • MDN Reference

            Parameters

            • input: RequestInfo | URL
            • Optionalinit: RequestInit

            Returns Promise<Response>

          • (input: string | Request | URL, init?: RequestInit): Promise<Response>

          • MDN Reference

            Parameters

            • input: string | Request | URL
            • Optionalinit: RequestInit

            Returns Promise<Response>

      • options: { authToken?: string; baseUrl: string } = ...

      Returns PricesApi

    Methods

    • Parameters

      • body: {
            category_tag?: null | string;
            currency:
                | "BND"
                | "UGX"
                | "HTG"
                | "ITL"
                | "SVC"
                | "VUV"
                | "XBA"
                | "COU"
                | "GRD"
                | "LTT"
                | "ZRZ"
                | "MZM"
                | "KPW"
                | "DZD"
                | "BBD"
                | "LUC"
                | "MOP"
                | "LKR"
                | "GBP"
                | "PHP"
                | "TTD"
                | "RHD"
                | "ATS"
                | "IEP"
                | "DJF"
                | "ILP"
                | "AED"
                | "ARL"
                | "INR"
                | "GEK"
                | "ZWD"
                | "CUP"
                | "RSD"
                | "XRE"
                | "BRR"
                | "NIC"
                | "USD"
                | "ZMW"
                | "MKD"
                | "BAD"
                | "XAG"
                | "BRC"
                | "BGO"
                | "NGN"
                | "UGS"
                | "IQD"
                | "TMT"
                | "VEF"
                | "ARA"
                | "ZMK"
                | "GQE"
                | "MDL"
                | "AOR"
                | "XAU"
                | "HKD"
                | "BTN"
                | "SDD"
                | "UAK"
                | "QAR"
                | "CLP"
                | "TRY"
                | "GEL"
                | "OMR"
                | "ROL"
                | "XPT"
                | "SAR"
                | "YER"
                | "UYI"
                | "ARP"
                | "BYR"
                | "JPY"
                | "COP"
                | "KZT"
                | "MAF"
                | "KGS"
                | "TZS"
                | "PGK"
                | "TOP"
                | "LUL"
                | "XBD"
                | "MMK"
                | "MNT"
                | "CAD"
                | "RON"
                | "ISK"
                | "XPF"
                | "CVE"
                | "MRU"
                | "BRL"
                | "MUR"
                | "PEI"
                | "BOP"
                | "THB"
                | "BEF"
                | "SYP"
                | "LTL"
                | "MRO"
                | "MDC"
                | "AZM"
                | "XEU"
                | "SSP"
                | "YDD"
                | "UYW"
                | "EGP"
                | "FKP"
                | "MZE"
                | "ERN"
                | "PYG"
                | "XXX"
                | "SEK"
                | "SUR"
                | "XOF"
                | "LYD"
                | "HRD"
                | "SRG"
                | "PKR"
                | "SHP"
                | "CNH"
                | "GNS"
                | "BEL"
                | "SLL"
                | "CLF"
                | "BMD"
                | "BRN"
                | "NZD"
                | "MXP"
                | "GTQ"
                | "TJS"
                | "ILR"
                | "MGA"
                | "PTE"
                | "PES"
                | "ETB"
                | "BRZ"
                | "LRD"
                | "CSK"
                | "AFA"
                | "KRH"
                | "LVL"
                | "CSD"
                | "ISJ"
                | "LAK"
                | "PLN"
                | "VEB"
                | "LVR"
                | "XFO"
                | "ZWR"
                | "XPD"
                | "TPE"
                | "DKK"
                | "ZRN"
                | "AMD"
                | "GHS"
                | "EUR"
                | "NOK"
                | "ZWL"
                | "VNN"
                | "AON"
                | "RUB"
                | "TRL"
                | "VND"
                | "MYR"
                | "UYP"
                | "ZAR"
                | "MGF"
                | "SZL"
                | "BAN"
                | "CHF"
                | "WST"
                | "XDR"
                | "BAM"
                | "CNY"
                | "MVR"
                | "BRE"
                | "DOP"
                | "MZN"
                | "FIM"
                | "BRB"
                | "PEN"
                | "SKK"
                | "USS"
                | "CZK"
                | "SOS"
                | "TND"
                | "BOB"
                | "ESB"
                | "GNF"
                | "MCF"
                | "MLF"
                | "FJD"
                | "AUD"
                | "AOA"
                | "ADP"
                | "MTL"
                | "AWG"
                | "ALK"
                | "IDR"
                | "JOD"
                | "GIP"
                | "JMD"
                | "CHW"
                | "CLE"
                | "BYB"
                | "BOV"
                | "FRF"
                | "LSL"
                | "KES"
                | "SGD"
                | "KYD"
                | "CRC"
                | "GWP"
                | "XTS"
                | "BOL"
                | "AOK"
                | "RWF"
                | "SLE"
                | "SIT"
                | "VES"
                | "ZAL"
                | "CNX"
                | "XSU"
                | "GWE"
                | "GYD"
                | "BDT"
                | "MXN"
                | "XCD"
                | "GHC"
                | "TWD"
                | "XBC"
                | "CHE"
                | "YUR"
                | "BSD"
                | "DEM"
                | "BWP"
                | "MAD"
                | "RUR"
                | "HRK"
                | "STN"
                | "BUK"
                | "MWK"
                | "NLG"
                | "PLZ"
                | "UYU"
                | "SBD"
                | "EEK"
                | "DDM"
                | "MKN"
                | "MVP"
                | "HUF"
                | "MXV"
                | "KRW"
                | "ILS"
                | "ARM"
                | "YUM"
                | "ANG"
                | "SRD"
                | "CUC"
                | "AFN"
                | "NIO"
                | "IRR"
                | "KHR"
                | "VED"
                | "ECV"
                | "SDG"
                | "TMM"
                | "MTP"
                | "NAD"
                | "TJR"
                | "XBB"
                | "STD"
                | "XFU"
                | "ALL"
                | "YUN"
                | "BYN"
                | "CDF"
                | "XAF"
                | "BGM"
                | "BHD"
                | "SDP"
                | "AZN"
                | "BEC"
                | "NPR"
                | "KMF"
                | "KWD"
                | "GMD"
                | "BGN"
                | "KRO"
                | "LBP"
                | "LUF"
                | "UZS"
                | "SCR"
                | "YUD"
                | "UAH"
                | "ESP"
                | "ECS"
                | "ESA"
                | "BGL"
                | "ARS"
                | "CYP"
                | "XUA"
                | "BIF"
                | "PAB"
                | "BZD"
                | "USN"
                | "HNL";
            date: string;
            labels_tags?: null
            | string[];
            location_osm_id: number;
            location_osm_type: "NODE" | "WAY" | "RELATION";
            origins_tags?: null | string[];
            price: number;
            price_is_discounted?: boolean;
            price_per?: null | "UNIT" | "KILOGRAM";
            price_without_discount?: null | number;
            product_code?: null | string;
            product_name?: null | string;
            proof_id?: null | number;
        }
        • Optionalcategory_tag?: null | string

          Category Tag

          ID of the Open Food Facts category of the product for products without barcode.

              This is mostly for raw products such as vegetables or fruits. This
    field is exclusive with `product_code`: if this field is set, it means
    that the product does not have a barcode.

    This ID must be a canonical category ID in the Open Food Facts taxonomy.
    If the ID is not valid, the price will be rejected.
        • currency:
              | "BND"
              | "UGX"
              | "HTG"
              | "ITL"
              | "SVC"
              | "VUV"
              | "XBA"
              | "COU"
              | "GRD"
              | "LTT"
              | "ZRZ"
              | "MZM"
              | "KPW"
              | "DZD"
              | "BBD"
              | "LUC"
              | "MOP"
              | "LKR"
              | "GBP"
              | "PHP"
              | "TTD"
              | "RHD"
              | "ATS"
              | "IEP"
              | "DJF"
              | "ILP"
              | "AED"
              | "ARL"
              | "INR"
              | "GEK"
              | "ZWD"
              | "CUP"
              | "RSD"
              | "XRE"
              | "BRR"
              | "NIC"
              | "USD"
              | "ZMW"
              | "MKD"
              | "BAD"
              | "XAG"
              | "BRC"
              | "BGO"
              | "NGN"
              | "UGS"
              | "IQD"
              | "TMT"
              | "VEF"
              | "ARA"
              | "ZMK"
              | "GQE"
              | "MDL"
              | "AOR"
              | "XAU"
              | "HKD"
              | "BTN"
              | "SDD"
              | "UAK"
              | "QAR"
              | "CLP"
              | "TRY"
              | "GEL"
              | "OMR"
              | "ROL"
              | "XPT"
              | "SAR"
              | "YER"
              | "UYI"
              | "ARP"
              | "BYR"
              | "JPY"
              | "COP"
              | "KZT"
              | "MAF"
              | "KGS"
              | "TZS"
              | "PGK"
              | "TOP"
              | "LUL"
              | "XBD"
              | "MMK"
              | "MNT"
              | "CAD"
              | "RON"
              | "ISK"
              | "XPF"
              | "CVE"
              | "MRU"
              | "BRL"
              | "MUR"
              | "PEI"
              | "BOP"
              | "THB"
              | "BEF"
              | "SYP"
              | "LTL"
              | "MRO"
              | "MDC"
              | "AZM"
              | "XEU"
              | "SSP"
              | "YDD"
              | "UYW"
              | "EGP"
              | "FKP"
              | "MZE"
              | "ERN"
              | "PYG"
              | "XXX"
              | "SEK"
              | "SUR"
              | "XOF"
              | "LYD"
              | "HRD"
              | "SRG"
              | "PKR"
              | "SHP"
              | "CNH"
              | "GNS"
              | "BEL"
              | "SLL"
              | "CLF"
              | "BMD"
              | "BRN"
              | "NZD"
              | "MXP"
              | "GTQ"
              | "TJS"
              | "ILR"
              | "MGA"
              | "PTE"
              | "PES"
              | "ETB"
              | "BRZ"
              | "LRD"
              | "CSK"
              | "AFA"
              | "KRH"
              | "LVL"
              | "CSD"
              | "ISJ"
              | "LAK"
              | "PLN"
              | "VEB"
              | "LVR"
              | "XFO"
              | "ZWR"
              | "XPD"
              | "TPE"
              | "DKK"
              | "ZRN"
              | "AMD"
              | "GHS"
              | "EUR"
              | "NOK"
              | "ZWL"
              | "VNN"
              | "AON"
              | "RUB"
              | "TRL"
              | "VND"
              | "MYR"
              | "UYP"
              | "ZAR"
              | "MGF"
              | "SZL"
              | "BAN"
              | "CHF"
              | "WST"
              | "XDR"
              | "BAM"
              | "CNY"
              | "MVR"
              | "BRE"
              | "DOP"
              | "MZN"
              | "FIM"
              | "BRB"
              | "PEN"
              | "SKK"
              | "USS"
              | "CZK"
              | "SOS"
              | "TND"
              | "BOB"
              | "ESB"
              | "GNF"
              | "MCF"
              | "MLF"
              | "FJD"
              | "AUD"
              | "AOA"
              | "ADP"
              | "MTL"
              | "AWG"
              | "ALK"
              | "IDR"
              | "JOD"
              | "GIP"
              | "JMD"
              | "CHW"
              | "CLE"
              | "BYB"
              | "BOV"
              | "FRF"
              | "LSL"
              | "KES"
              | "SGD"
              | "KYD"
              | "CRC"
              | "GWP"
              | "XTS"
              | "BOL"
              | "AOK"
              | "RWF"
              | "SLE"
              | "SIT"
              | "VES"
              | "ZAL"
              | "CNX"
              | "XSU"
              | "GWE"
              | "GYD"
              | "BDT"
              | "MXN"
              | "XCD"
              | "GHC"
              | "TWD"
              | "XBC"
              | "CHE"
              | "YUR"
              | "BSD"
              | "DEM"
              | "BWP"
              | "MAD"
              | "RUR"
              | "HRK"
              | "STN"
              | "BUK"
              | "MWK"
              | "NLG"
              | "PLZ"
              | "UYU"
              | "SBD"
              | "EEK"
              | "DDM"
              | "MKN"
              | "MVP"
              | "HUF"
              | "MXV"
              | "KRW"
              | "ILS"
              | "ARM"
              | "YUM"
              | "ANG"
              | "SRD"
              | "CUC"
              | "AFN"
              | "NIO"
              | "IRR"
              | "KHR"
              | "VED"
              | "ECV"
              | "SDG"
              | "TMM"
              | "MTP"
              | "NAD"
              | "TJR"
              | "XBB"
              | "STD"
              | "XFU"
              | "ALL"
              | "YUN"
              | "BYN"
              | "CDF"
              | "XAF"
              | "BGM"
              | "BHD"
              | "SDP"
              | "AZN"
              | "BEC"
              | "NPR"
              | "KMF"
              | "KWD"
              | "GMD"
              | "BGN"
              | "KRO"
              | "LBP"
              | "LUF"
              | "UZS"
              | "SCR"
              | "YUD"
              | "UAH"
              | "ESP"
              | "ECS"
              | "ESA"
              | "BGL"
              | "ARS"
              | "CYP"
              | "XUA"
              | "BIF"
              | "PAB"
              | "BZD"
              | "USN"
              | "HNL"

          currency of the price, as a string. The currency must be a valid currency code. See https://en.wikipedia.org/wiki/ISO_4217 for a list of valid currency codes.

        • date: string

          Date Format: date

          date when the product was bought.

        • Optionallabels_tags?: null | string[]

          Labels Tags

          labels of the product, only for products without barcode.

              The labels must be valid labels in the Open Food Facts taxonomy.
    If one of the labels is not valid, the price will be rejected.

    The most common labels are:
    - `en:organic`: the product is organic
    - `fr:ab-agriculture-biologique`: the product is organic, in France
    - `en:fair-trade`: the product is fair-trade

    Other labels can be provided if relevant.
        • location_osm_id: number

          Location Osm Id

          ID of the location in OpenStreetMap: the store where the product was bought.

        • location_osm_type: "NODE" | "WAY" | "RELATION"

          type of the OpenStreetMap location object. Stores can be represented as nodes, ways or relations in OpenStreetMap. It is necessary to be able to fetch the correct information about the store using the ID.

        • Optionalorigins_tags?: null | string[]

          Origins Tags

          origins of the product, only for products without barcode.

              This field is a list as some products may be a mix of several origins,
    but most products have only one origin.

    The origins must be valid origins in the Open Food Facts taxonomy.
    If one of the origins is not valid, the price will be rejected.
        • price: number

          Price

          price of the product, without its currency, taxes included.

        • Optionalprice_is_discounted?: boolean

          Price Is Discounted

          true if the price is discounted.

          false
        • Optionalprice_per?: null | "UNIT" | "KILOGRAM"

          if the price is about a barcode-less product (if category_tag is provided), this field must be set to KILOGRAM or UNIT (KILOGRAM by default). This field is set to null and ignored if product_code is provided.

          KILOGRAM
        • Optionalprice_without_discount?: null | number

          Price Without Discount

          price of the product without discount, without its currency, taxes included. If the product is not discounted, this field must be null.

        • Optionalproduct_code?: null | string

          Product Code

          barcode (EAN) of the product, as a string.

        • Optionalproduct_name?: null | string

          Product Name

          name of the product, as displayed on the receipt or the price tag.

        • Optionalproof_id?: null | number

          Proof Id

          ID of the proof, if any. The proof is a file (receipt or price tag image) uploaded by the user to prove the price of the product. The proof must be uploaded before the price, and the authenticated user must be the owner of the proof.

      Returns Promise<
          FetchResponse<
              {
                  requestBody: {
                      content: {
                          "application/json": {
                              category_tag?: null
                              | string;
                              currency:
                                  | "BND"
                                  | "UGX"
                                  | "HTG"
                                  | "ITL"
                                  | "SVC"
                                  | "VUV"
                                  | "XBA"
                                  | "COU"
                                  | "GRD"
                                  | "LTT"
                                  | "ZRZ"
                                  | "MZM"
                                  | "KPW"
                                  | "DZD"
                                  | "BBD"
                                  | "LUC"
                                  | "MOP"
                                  | "LKR"
                                  | "GBP"
                                  | "PHP"
                                  | "TTD"
                                  | "RHD"
                                  | "ATS"
                                  | "IEP"
                                  | "DJF"
                                  | "ILP"
                                  | "AED"
                                  | "ARL"
                                  | "INR"
                                  | "GEK"
                                  | "ZWD"
                                  | "CUP"
                                  | "RSD"
                                  | "XRE"
                                  | "BRR"
                                  | "NIC"
                                  | "USD"
                                  | "ZMW"
                                  | "MKD"
                                  | "BAD"
                                  | "XAG"
                                  | "BRC"
                                  | "BGO"
                                  | "NGN"
                                  | "UGS"
                                  | "IQD"
                                  | "TMT"
                                  | "VEF"
                                  | "ARA"
                                  | "ZMK"
                                  | "GQE"
                                  | "MDL"
                                  | "AOR"
                                  | "XAU"
                                  | "HKD"
                                  | "BTN"
                                  | "SDD"
                                  | "UAK"
                                  | "QAR"
                                  | "CLP"
                                  | "TRY"
                                  | "GEL"
                                  | "OMR"
                                  | "ROL"
                                  | "XPT"
                                  | "SAR"
                                  | "YER"
                                  | "UYI"
                                  | "ARP"
                                  | "BYR"
                                  | "JPY"
                                  | "COP"
                                  | "KZT"
                                  | "MAF"
                                  | "KGS"
                                  | "TZS"
                                  | "PGK"
                                  | "TOP"
                                  | "LUL"
                                  | "XBD"
                                  | "MMK"
                                  | "MNT"
                                  | "CAD"
                                  | "RON"
                                  | "ISK"
                                  | "XPF"
                                  | "CVE"
                                  | "MRU"
                                  | "BRL"
                                  | "MUR"
                                  | "PEI"
                                  | "BOP"
                                  | "THB"
                                  | "BEF"
                                  | "SYP"
                                  | "LTL"
                                  | "MRO"
                                  | "MDC"
                                  | "AZM"
                                  | "XEU"
                                  | "SSP"
                                  | "YDD"
                                  | "UYW"
                                  | "EGP"
                                  | "FKP"
                                  | "MZE"
                                  | "ERN"
                                  | "PYG"
                                  | "XXX"
                                  | "SEK"
                                  | "SUR"
                                  | "XOF"
                                  | "LYD"
                                  | "HRD"
                                  | "SRG"
                                  | "PKR"
                                  | "SHP"
                                  | "CNH"
                                  | "GNS"
                                  | "BEL"
                                  | "SLL"
                                  | "CLF"
                                  | "BMD"
                                  | "BRN"
                                  | "NZD"
                                  | "MXP"
                                  | "GTQ"
                                  | "TJS"
                                  | "ILR"
                                  | "MGA"
                                  | "PTE"
                                  | "PES"
                                  | "ETB"
                                  | "BRZ"
                                  | "LRD"
                                  | "CSK"
                                  | "AFA"
                                  | "KRH"
                                  | "LVL"
                                  | "CSD"
                                  | "ISJ"
                                  | "LAK"
                                  | "PLN"
                                  | "VEB"
                                  | "LVR"
                                  | "XFO"
                                  | "ZWR"
                                  | "XPD"
                                  | "TPE"
                                  | "DKK"
                                  | "ZRN"
                                  | "AMD"
                                  | "GHS"
                                  | "EUR"
                                  | "NOK"
                                  | "ZWL"
                                  | "VNN"
                                  | "AON"
                                  | "RUB"
                                  | "TRL"
                                  | "VND"
                                  | "MYR"
                                  | "UYP"
                                  | "ZAR"
                                  | "MGF"
                                  | "SZL"
                                  | "BAN"
                                  | "CHF"
                                  | "WST"
                                  | "XDR"
                                  | "BAM"
                                  | "CNY"
                                  | "MVR"
                                  | "BRE"
                                  | "DOP"
                                  | "MZN"
                                  | "FIM"
                                  | "BRB"
                                  | "PEN"
                                  | "SKK"
                                  | "USS"
                                  | "CZK"
                                  | "SOS"
                                  | "TND"
                                  | "BOB"
                                  | "ESB"
                                  | "GNF"
                                  | "MCF"
                                  | "MLF"
                                  | "FJD"
                                  | "AUD"
                                  | "AOA"
                                  | "ADP"
                                  | "MTL"
                                  | "AWG"
                                  | "ALK"
                                  | "IDR"
                                  | "JOD"
                                  | "GIP"
                                  | "JMD"
                                  | "CHW"
                                  | "CLE"
                                  | "BYB"
                                  | "BOV"
                                  | "FRF"
                                  | "LSL"
                                  | "KES"
                                  | "SGD"
                                  | "KYD"
                                  | "CRC"
                                  | "GWP"
                                  | "XTS"
                                  | "BOL"
                                  | "AOK"
                                  | "RWF"
                                  | "SLE"
                                  | "SIT"
                                  | "VES"
                                  | "ZAL"
                                  | "CNX"
                                  | "XSU"
                                  | "GWE"
                                  | "GYD"
                                  | "BDT"
                                  | "MXN"
                                  | "XCD"
                                  | "GHC"
                                  | "TWD"
                                  | "XBC"
                                  | "CHE"
                                  | "YUR"
                                  | "BSD"
                                  | "DEM"
                                  | "BWP"
                                  | "MAD"
                                  | "RUR"
                                  | "HRK"
                                  | "STN"
                                  | "BUK"
                                  | "MWK"
                                  | "NLG"
                                  | "PLZ"
                                  | "UYU"
                                  | "SBD"
                                  | "EEK"
                                  | "DDM"
                                  | "MKN"
                                  | "MVP"
                                  | "HUF"
                                  | "MXV"
                                  | "KRW"
                                  | "ILS"
                                  | "ARM"
                                  | "YUM"
                                  | "ANG"
                                  | "SRD"
                                  | "CUC"
                                  | "AFN"
                                  | "NIO"
                                  | "IRR"
                                  | "KHR"
                                  | "VED"
                                  | "ECV"
                                  | "SDG"
                                  | "TMM"
                                  | "MTP"
                                  | "NAD"
                                  | "TJR"
                                  | "XBB"
                                  | "STD"
                                  | "XFU"
                                  | "ALL"
                                  | "YUN"
                                  | "BYN"
                                  | "CDF"
                                  | "XAF"
                                  | "BGM"
                                  | "BHD"
                                  | "SDP"
                                  | "AZN"
                                  | "BEC"
                                  | "NPR"
                                  | "KMF"
                                  | "KWD"
                                  | "GMD"
                                  | "BGN"
                                  | "KRO"
                                  | "LBP"
                                  | "LUF"
                                  | "UZS"
                                  | "SCR"
                                  | "YUD"
                                  | "UAH"
                                  | "ESP"
                                  | "ECS"
                                  | "ESA"
                                  | "BGL"
                                  | "ARS"
                                  | "CYP"
                                  | "XUA"
                                  | "BIF"
                                  | "PAB"
                                  | "BZD"
                                  | "USN"
                                  | "HNL";
                              date: string;
                              labels_tags?: null
                              | string[];
                              location_osm_id: number;
                              location_osm_type: "NODE" | "WAY" | "RELATION";
                              origins_tags?: null | string[];
                              price: number;
                              price_is_discounted?: boolean;
                              price_per?: null | "UNIT" | "KILOGRAM";
                              price_without_discount?: null | number;
                              product_code?: null | string;
                              product_name?: null | string;
                              proof_id?: null | number;
                          };
                      };
                  };
                  responses: {
                      "201": {
                          content: {
                              "application/json": {
                                  category_tag?: null
                                  | string;
                                  created: string;
                                  currency:
                                      | "BND"
                                      | "UGX"
                                      | "HTG"
                                      | "ITL"
                                      | "SVC"
                                      | "VUV"
                                      | "XBA"
                                      | "COU"
                                      | "GRD"
                                      | "LTT"
                                      | "ZRZ"
                                      | "MZM"
                                      | "KPW"
                                      | "DZD"
                                      | "BBD"
                                      | "LUC"
                                      | "MOP"
                                      | "LKR"
                                      | "GBP"
                                      | "PHP"
                                      | "TTD"
                                      | "RHD"
                                      | "ATS"
                                      | "IEP"
                                      | "DJF"
                                      | "ILP"
                                      | "AED"
                                      | "ARL"
                                      | "INR"
                                      | "GEK"
                                      | "ZWD"
                                      | "CUP"
                                      | "RSD"
                                      | "XRE"
                                      | "BRR"
                                      | "NIC"
                                      | "USD"
                                      | "ZMW"
                                      | "MKD"
                                      | "BAD"
                                      | "XAG"
                                      | "BRC"
                                      | "BGO"
                                      | "NGN"
                                      | "UGS"
                                      | "IQD"
                                      | "TMT"
                                      | "VEF"
                                      | "ARA"
                                      | "ZMK"
                                      | "GQE"
                                      | "MDL"
                                      | "AOR"
                                      | "XAU"
                                      | "HKD"
                                      | "BTN"
                                      | "SDD"
                                      | "UAK"
                                      | "QAR"
                                      | "CLP"
                                      | "TRY"
                                      | "GEL"
                                      | "OMR"
                                      | "ROL"
                                      | "XPT"
                                      | "SAR"
                                      | "YER"
                                      | "UYI"
                                      | "ARP"
                                      | "BYR"
                                      | "JPY"
                                      | "COP"
                                      | "KZT"
                                      | "MAF"
                                      | "KGS"
                                      | "TZS"
                                      | "PGK"
                                      | "TOP"
                                      | "LUL"
                                      | "XBD"
                                      | "MMK"
                                      | "MNT"
                                      | "CAD"
                                      | "RON"
                                      | "ISK"
                                      | "XPF"
                                      | "CVE"
                                      | "MRU"
                                      | "BRL"
                                      | "MUR"
                                      | "PEI"
                                      | "BOP"
                                      | "THB"
                                      | "BEF"
                                      | "SYP"
                                      | "LTL"
                                      | "MRO"
                                      | "MDC"
                                      | "AZM"
                                      | "XEU"
                                      | "SSP"
                                      | "YDD"
                                      | "UYW"
                                      | "EGP"
                                      | "FKP"
                                      | "MZE"
                                      | "ERN"
                                      | "PYG"
                                      | "XXX"
                                      | "SEK"
                                      | "SUR"
                                      | "XOF"
                                      | "LYD"
                                      | "HRD"
                                      | "SRG"
                                      | "PKR"
                                      | "SHP"
                                      | "CNH"
                                      | "GNS"
                                      | "BEL"
                                      | "SLL"
                                      | "CLF"
                                      | "BMD"
                                      | "BRN"
                                      | "NZD"
                                      | "MXP"
                                      | "GTQ"
                                      | "TJS"
                                      | "ILR"
                                      | "MGA"
                                      | "PTE"
                                      | "PES"
                                      | "ETB"
                                      | "BRZ"
                                      | "LRD"
                                      | "CSK"
                                      | "AFA"
                                      | "KRH"
                                      | "LVL"
                                      | "CSD"
                                      | "ISJ"
                                      | "LAK"
                                      | "PLN"
                                      | "VEB"
                                      | "LVR"
                                      | "XFO"
                                      | "ZWR"
                                      | "XPD"
                                      | "TPE"
                                      | "DKK"
                                      | "ZRN"
                                      | "AMD"
                                      | "GHS"
                                      | "EUR"
                                      | "NOK"
                                      | "ZWL"
                                      | "VNN"
                                      | "AON"
                                      | "RUB"
                                      | "TRL"
                                      | "VND"
                                      | "MYR"
                                      | "UYP"
                                      | "ZAR"
                                      | "MGF"
                                      | "SZL"
                                      | "BAN"
                                      | "CHF"
                                      | "WST"
                                      | "XDR"
                                      | "BAM"
                                      | "CNY"
                                      | "MVR"
                                      | "BRE"
                                      | "DOP"
                                      | "MZN"
                                      | "FIM"
                                      | "BRB"
                                      | "PEN"
                                      | "SKK"
                                      | "USS"
                                      | "CZK"
                                      | "SOS"
                                      | "TND"
                                      | "BOB"
                                      | "ESB"
                                      | "GNF"
                                      | "MCF"
                                      | "MLF"
                                      | "FJD"
                                      | "AUD"
                                      | "AOA"
                                      | "ADP"
                                      | "MTL"
                                      | "AWG"
                                      | "ALK"
                                      | "IDR"
                                      | "JOD"
                                      | "GIP"
                                      | "JMD"
                                      | "CHW"
                                      | "CLE"
                                      | "BYB"
                                      | "BOV"
                                      | "FRF"
                                      | "LSL"
                                      | "KES"
                                      | "SGD"
                                      | "KYD"
                                      | "CRC"
                                      | "GWP"
                                      | "XTS"
                                      | "BOL"
                                      | "AOK"
                                      | "RWF"
                                      | "SLE"
                                      | "SIT"
                                      | "VES"
                                      | "ZAL"
                                      | "CNX"
                                      | "XSU"
                                      | "GWE"
                                      | "GYD"
                                      | "BDT"
                                      | "MXN"
                                      | "XCD"
                                      | "GHC"
                                      | "TWD"
                                      | "XBC"
                                      | "CHE"
                                      | "YUR"
                                      | "BSD"
                                      | "DEM"
                                      | "BWP"
                                      | "MAD"
                                      | "RUR"
                                      | "HRK"
                                      | "STN"
                                      | "BUK"
                                      | "MWK"
                                      | "NLG"
                                      | "PLZ"
                                      | "UYU"
                                      | "SBD"
                                      | "EEK"
                                      | "DDM"
                                      | "MKN"
                                      | "MVP"
                                      | "HUF"
                                      | "MXV"
                                      | "KRW"
                                      | "ILS"
                                      | "ARM"
                                      | "YUM"
                                      | "ANG"
                                      | "SRD"
                                      | "CUC"
                                      | "AFN"
                                      | "NIO"
                                      | "IRR"
                                      | "KHR"
                                      | "VED"
                                      | "ECV"
                                      | "SDG"
                                      | "TMM"
                                      | "MTP"
                                      | "NAD"
                                      | "TJR"
                                      | "XBB"
                                      | "STD"
                                      | "XFU"
                                      | "ALL"
                                      | "YUN"
                                      | "BYN"
                                      | "CDF"
                                      | "XAF"
                                      | "BGM"
                                      | "BHD"
                                      | "SDP"
                                      | "AZN"
                                      | "BEC"
                                      | "NPR"
                                      | "KMF"
                                      | "KWD"
                                      | "GMD"
                                      | "BGN"
                                      | "KRO"
                                      | "LBP"
                                      | "LUF"
                                      | "UZS"
                                      | "SCR"
                                      | "YUD"
                                      | "UAH"
                                      | "ESP"
                                      | "ECS"
                                      | "ESA"
                                      | "BGL"
                                      | "ARS"
                                      | "CYP"
                                      | "XUA"
                                      | "BIF"
                                      | "PAB"
                                      | "BZD"
                                      | "USN"
                                      | "HNL";
                                  date: string;
                                  labels_tags?: null
                                  | string[];
                                  location_id: null | number;
                                  location_osm_id: number;
                                  location_osm_type: "NODE" | "WAY" | "RELATION";
                                  origins_tags?: null | string[];
                                  owner: string;
                                  price: number;
                                  price_is_discounted?: boolean;
                                  price_per?: null | "UNIT" | "KILOGRAM";
                                  price_without_discount?: null | number;
                                  product_code?: null | string;
                                  product_id: null | number;
                                  product_name?: null | string;
                                  proof_id?: null | number;
                              };
                          };
                      };
                      "422": {
                          content: {
                              "application/json": {
                                  detail?: { loc: (...)[]; msg: string; type: string }[];
                              };
                          };
                      };
                  };
              },
              {
                  body: {
                      category_tag?: null
                      | string;
                      currency:
                          | "BND"
                          | "UGX"
                          | "HTG"
                          | "ITL"
                          | "SVC"
                          | "VUV"
                          | "XBA"
                          | "COU"
                          | "GRD"
                          | "LTT"
                          | "ZRZ"
                          | "MZM"
                          | "KPW"
                          | "DZD"
                          | "BBD"
                          | "LUC"
                          | "MOP"
                          | "LKR"
                          | "GBP"
                          | "PHP"
                          | "TTD"
                          | "RHD"
                          | "ATS"
                          | "IEP"
                          | "DJF"
                          | "ILP"
                          | "AED"
                          | "ARL"
                          | "INR"
                          | "GEK"
                          | "ZWD"
                          | "CUP"
                          | "RSD"
                          | "XRE"
                          | "BRR"
                          | "NIC"
                          | "USD"
                          | "ZMW"
                          | "MKD"
                          | "BAD"
                          | "XAG"
                          | "BRC"
                          | "BGO"
                          | "NGN"
                          | "UGS"
                          | "IQD"
                          | "TMT"
                          | "VEF"
                          | "ARA"
                          | "ZMK"
                          | "GQE"
                          | "MDL"
                          | "AOR"
                          | "XAU"
                          | "HKD"
                          | "BTN"
                          | "SDD"
                          | "UAK"
                          | "QAR"
                          | "CLP"
                          | "TRY"
                          | "GEL"
                          | "OMR"
                          | "ROL"
                          | "XPT"
                          | "SAR"
                          | "YER"
                          | "UYI"
                          | "ARP"
                          | "BYR"
                          | "JPY"
                          | "COP"
                          | "KZT"
                          | "MAF"
                          | "KGS"
                          | "TZS"
                          | "PGK"
                          | "TOP"
                          | "LUL"
                          | "XBD"
                          | "MMK"
                          | "MNT"
                          | "CAD"
                          | "RON"
                          | "ISK"
                          | "XPF"
                          | "CVE"
                          | "MRU"
                          | "BRL"
                          | "MUR"
                          | "PEI"
                          | "BOP"
                          | "THB"
                          | "BEF"
                          | "SYP"
                          | "LTL"
                          | "MRO"
                          | "MDC"
                          | "AZM"
                          | "XEU"
                          | "SSP"
                          | "YDD"
                          | "UYW"
                          | "EGP"
                          | "FKP"
                          | "MZE"
                          | "ERN"
                          | "PYG"
                          | "XXX"
                          | "SEK"
                          | "SUR"
                          | "XOF"
                          | "LYD"
                          | "HRD"
                          | "SRG"
                          | "PKR"
                          | "SHP"
                          | "CNH"
                          | "GNS"
                          | "BEL"
                          | "SLL"
                          | "CLF"
                          | "BMD"
                          | "BRN"
                          | "NZD"
                          | "MXP"
                          | "GTQ"
                          | "TJS"
                          | "ILR"
                          | "MGA"
                          | "PTE"
                          | "PES"
                          | "ETB"
                          | "BRZ"
                          | "LRD"
                          | "CSK"
                          | "AFA"
                          | "KRH"
                          | "LVL"
                          | "CSD"
                          | "ISJ"
                          | "LAK"
                          | "PLN"
                          | "VEB"
                          | "LVR"
                          | "XFO"
                          | "ZWR"
                          | "XPD"
                          | "TPE"
                          | "DKK"
                          | "ZRN"
                          | "AMD"
                          | "GHS"
                          | "EUR"
                          | "NOK"
                          | "ZWL"
                          | "VNN"
                          | "AON"
                          | "RUB"
                          | "TRL"
                          | "VND"
                          | "MYR"
                          | "UYP"
                          | "ZAR"
                          | "MGF"
                          | "SZL"
                          | "BAN"
                          | "CHF"
                          | "WST"
                          | "XDR"
                          | "BAM"
                          | "CNY"
                          | "MVR"
                          | "BRE"
                          | "DOP"
                          | "MZN"
                          | "FIM"
                          | "BRB"
                          | "PEN"
                          | "SKK"
                          | "USS"
                          | "CZK"
                          | "SOS"
                          | "TND"
                          | "BOB"
                          | "ESB"
                          | "GNF"
                          | "MCF"
                          | "MLF"
                          | "FJD"
                          | "AUD"
                          | "AOA"
                          | "ADP"
                          | "MTL"
                          | "AWG"
                          | "ALK"
                          | "IDR"
                          | "JOD"
                          | "GIP"
                          | "JMD"
                          | "CHW"
                          | "CLE"
                          | "BYB"
                          | "BOV"
                          | "FRF"
                          | "LSL"
                          | "KES"
                          | "SGD"
                          | "KYD"
                          | "CRC"
                          | "GWP"
                          | "XTS"
                          | "BOL"
                          | "AOK"
                          | "RWF"
                          | "SLE"
                          | "SIT"
                          | "VES"
                          | "ZAL"
                          | "CNX"
                          | "XSU"
                          | "GWE"
                          | "GYD"
                          | "BDT"
                          | "MXN"
                          | "XCD"
                          | "GHC"
                          | "TWD"
                          | "XBC"
                          | "CHE"
                          | "YUR"
                          | "BSD"
                          | "DEM"
                          | "BWP"
                          | "MAD"
                          | "RUR"
                          | "HRK"
                          | "STN"
                          | "BUK"
                          | "MWK"
                          | "NLG"
                          | "PLZ"
                          | "UYU"
                          | "SBD"
                          | "EEK"
                          | "DDM"
                          | "MKN"
                          | "MVP"
                          | "HUF"
                          | "MXV"
                          | "KRW"
                          | "ILS"
                          | "ARM"
                          | "YUM"
                          | "ANG"
                          | "SRD"
                          | "CUC"
                          | "AFN"
                          | "NIO"
                          | "IRR"
                          | "KHR"
                          | "VED"
                          | "ECV"
                          | "SDG"
                          | "TMM"
                          | "MTP"
                          | "NAD"
                          | "TJR"
                          | "XBB"
                          | "STD"
                          | "XFU"
                          | "ALL"
                          | "YUN"
                          | "BYN"
                          | "CDF"
                          | "XAF"
                          | "BGM"
                          | "BHD"
                          | "SDP"
                          | "AZN"
                          | "BEC"
                          | "NPR"
                          | "KMF"
                          | "KWD"
                          | "GMD"
                          | "BGN"
                          | "KRO"
                          | "LBP"
                          | "LUF"
                          | "UZS"
                          | "SCR"
                          | "YUD"
                          | "UAH"
                          | "ESP"
                          | "ECS"
                          | "ESA"
                          | "BGL"
                          | "ARS"
                          | "CYP"
                          | "XUA"
                          | "BIF"
                          | "PAB"
                          | "BZD"
                          | "USN"
                          | "HNL";
                      date: string;
                      labels_tags?: null
                      | string[];
                      location_osm_id: number;
                      location_osm_type: "NODE" | "WAY" | "RELATION";
                      origins_tags?: null | string[];
                      price: number;
                      price_is_discounted?: boolean;
                      price_per?: null | "UNIT" | "KILOGRAM";
                      price_without_discount?: null | number;
                      product_code?: null | string;
                      product_name?: null | string;
                      proof_id?: null | number;
                  };
              },
              `${string}/${string}`,
          >,
      >

    • Parameters

      • query:
            | undefined
            | {
                category_tag?: null
                | string;
                created__gte?: null | string;
                created__lte?: null | string;
                currency?: null | string;
                date?: null | string;
                date__gt?: null | string;
                date__gte?: null | string;
                date__lt?: null | string;
                date__lte?: null | string;
                labels_tags__like?: null | string;
                location_id?: null | number;
                location_osm_id?: null | number;
                location_osm_type?: null | "NODE" | "WAY" | "RELATION";
                order_by?: null | string;
                origins_tags__like?: null | string;
                owner?: null | string;
                page?: number;
                price?: null | number;
                price__gt?: null | number;
                price__gte?: null | number;
                price__lt?: null | number;
                price__lte?: null | number;
                price_is_discounted?: null | boolean;
                product_code?: null | string;
                product_id?: null | number;
                product_id__isnull?: null | boolean;
                size?: number;
            }
        • undefined
        • {
              category_tag?: null | string;
              created__gte?: null | string;
              created__lte?: null | string;
              currency?: null | string;
              date?: null | string;
              date__gt?: null | string;
              date__gte?: null | string;
              date__lt?: null | string;
              date__lte?: null | string;
              labels_tags__like?: null | string;
              location_id?: null | number;
              location_osm_id?: null | number;
              location_osm_type?: null | "NODE" | "WAY" | "RELATION";
              order_by?: null | string;
              origins_tags__like?: null | string;
              owner?: null | string;
              page?: number;
              price?: null | number;
              price__gt?: null | number;
              price__gte?: null | number;
              price__lt?: null | number;
              price__lte?: null | number;
              price_is_discounted?: null | boolean;
              product_code?: null | string;
              product_id?: null | number;
              product_id__isnull?: null | boolean;
              size?: number;
          }
          • Optionalcategory_tag?: null | string
          • Optionalcreated__gte?: null | string
          • Optionalcreated__lte?: null | string
          • Optionalcurrency?: null | string
          • Optionaldate?: null | string
          • Optionaldate__gt?: null | string
          • Optionaldate__gte?: null | string
          • Optionaldate__lt?: null | string
          • Optionaldate__lte?: null | string
          • Optionallabels_tags__like?: null | string
          • Optionallocation_id?: null | number
          • Optionallocation_osm_id?: null | number
          • Optionallocation_osm_type?: null | "NODE" | "WAY" | "RELATION"
          • Optionalorder_by?: null | string
          • Optionalorigins_tags__like?: null | string
          • Optionalowner?: null | string
          • Optionalpage?: number

            Page number

          • Optionalprice?: null | number
          • Optionalprice__gt?: null | number
          • Optionalprice__gte?: null | number
          • Optionalprice__lt?: null | number
          • Optionalprice__lte?: null | number
          • Optionalprice_is_discounted?: null | boolean
          • Optionalproduct_code?: null | string
          • Optionalproduct_id?: null | number
          • Optionalproduct_id__isnull?: null | boolean
          • Optionalsize?: number

            Page size

      Returns Promise<
          FetchResponse<
              {
                  parameters: {
                      query?: {
                          category_tag?: null
                          | string;
                          created__gte?: null | string;
                          created__lte?: null | string;
                          currency?: null | string;
                          date?: null | string;
                          date__gt?: null | string;
                          date__gte?: null | string;
                          date__lt?: null | string;
                          date__lte?: null | string;
                          labels_tags__like?: null | string;
                          location_id?: null | number;
                          location_osm_id?: null | number;
                          location_osm_type?: null | "NODE" | "WAY" | "RELATION";
                          order_by?: null | string;
                          origins_tags__like?: null | string;
                          owner?: null | string;
                          page?: number;
                          price?: null | number;
                          price__gt?: null | number;
                          price__gte?: null | number;
                          price__lt?: null | number;
                          price__lte?: null | number;
                          price_is_discounted?: null | boolean;
                          product_code?: null | string;
                          product_id?: null | number;
                          product_id__isnull?: null | boolean;
                          size?: number;
                      };
                  };
                  responses: {
                      "200": {
                          content: {
                              "application/json": {
                                  items: {
                                      category_tag?: null
                                      | string;
                                      created: string;
                                      currency:
                                          | "BND"
                                          | "UGX"
                                          | "HTG"
                                          | "ITL"
                                          | "SVC"
                                          | "VUV"
                                          | "XBA"
                                          | "COU"
                                          | "GRD"
                                          | "LTT"
                                          | "ZRZ"
                                          | "MZM"
                                          | "KPW"
                                          | "DZD"
                                          | "BBD"
                                          | "LUC"
                                          | "MOP"
                                          | "LKR"
                                          | "GBP"
                                          | "PHP"
                                          | "TTD"
                                          | "RHD"
                                          | "ATS"
                                          | "IEP"
                                          | "DJF"
                                          | "ILP"
                                          | "AED"
                                          | "ARL"
                                          | "INR"
                                          | "GEK"
                                          | "ZWD"
                                          | "CUP"
                                          | "RSD"
                                          | "XRE"
                                          | "BRR"
                                          | "NIC"
                                          | "USD"
                                          | "ZMW"
                                          | "MKD"
                                          | "BAD"
                                          | "XAG"
                                          | "BRC"
                                          | "BGO"
                                          | "NGN"
                                          | "UGS"
                                          | "IQD"
                                          | "TMT"
                                          | "VEF"
                                          | "ARA"
                                          | "ZMK"
                                          | "GQE"
                                          | "MDL"
                                          | "AOR"
                                          | "XAU"
                                          | "HKD"
                                          | "BTN"
                                          | "SDD"
                                          | "UAK"
                                          | "QAR"
                                          | "CLP"
                                          | "TRY"
                                          | "GEL"
                                          | "OMR"
                                          | "ROL"
                                          | "XPT"
                                          | "SAR"
                                          | "YER"
                                          | "UYI"
                                          | "ARP"
                                          | "BYR"
                                          | "JPY"
                                          | "COP"
                                          | "KZT"
                                          | "MAF"
                                          | "KGS"
                                          | "TZS"
                                          | "PGK"
                                          | "TOP"
                                          | "LUL"
                                          | "XBD"
                                          | "MMK"
                                          | "MNT"
                                          | "CAD"
                                          | "RON"
                                          | "ISK"
                                          | "XPF"
                                          | "CVE"
                                          | "MRU"
                                          | "BRL"
                                          | "MUR"
                                          | "PEI"
                                          | "BOP"
                                          | "THB"
                                          | "BEF"
                                          | "SYP"
                                          | "LTL"
                                          | "MRO"
                                          | "MDC"
                                          | "AZM"
                                          | "XEU"
                                          | "SSP"
                                          | "YDD"
                                          | "UYW"
                                          | "EGP"
                                          | "FKP"
                                          | "MZE"
                                          | "ERN"
                                          | "PYG"
                                          | "XXX"
                                          | "SEK"
                                          | "SUR"
                                          | "XOF"
                                          | "LYD"
                                          | "HRD"
                                          | "SRG"
                                          | "PKR"
                                          | "SHP"
                                          | "CNH"
                                          | "GNS"
                                          | "BEL"
                                          | "SLL"
                                          | "CLF"
                                          | "BMD"
                                          | "BRN"
                                          | "NZD"
                                          | "MXP"
                                          | "GTQ"
                                          | "TJS"
                                          | "ILR"
                                          | "MGA"
                                          | "PTE"
                                          | "PES"
                                          | "ETB"
                                          | "BRZ"
                                          | "LRD"
                                          | "CSK"
                                          | "AFA"
                                          | "KRH"
                                          | "LVL"
                                          | "CSD"
                                          | "ISJ"
                                          | "LAK"
                                          | "PLN"
                                          | "VEB"
                                          | "LVR"
                                          | "XFO"
                                          | "ZWR"
                                          | "XPD"
                                          | "TPE"
                                          | "DKK"
                                          | "ZRN"
                                          | "AMD"
                                          | "GHS"
                                          | "EUR"
                                          | "NOK"
                                          | "ZWL"
                                          | "VNN"
                                          | "AON"
                                          | "RUB"
                                          | "TRL"
                                          | "VND"
                                          | "MYR"
                                          | "UYP"
                                          | "ZAR"
                                          | "MGF"
                                          | "SZL"
                                          | "BAN"
                                          | "CHF"
                                          | "WST"
                                          | "XDR"
                                          | "BAM"
                                          | "CNY"
                                          | "MVR"
                                          | "BRE"
                                          | "DOP"
                                          | "MZN"
                                          | "FIM"
                                          | "BRB"
                                          | "PEN"
                                          | "SKK"
                                          | "USS"
                                          | "CZK"
                                          | "SOS"
                                          | "TND"
                                          | "BOB"
                                          | "ESB"
                                          | "GNF"
                                          | "MCF"
                                          | "MLF"
                                          | "FJD"
                                          | "AUD"
                                          | "AOA"
                                          | "ADP"
                                          | "MTL"
                                          | "AWG"
                                          | "ALK"
                                          | "IDR"
                                          | "JOD"
                                          | "GIP"
                                          | "JMD"
                                          | "CHW"
                                          | "CLE"
                                          | "BYB"
                                          | "BOV"
                                          | "FRF"
                                          | "LSL"
                                          | "KES"
                                          | "SGD"
                                          | "KYD"
                                          | "CRC"
                                          | "GWP"
                                          | "XTS"
                                          | "BOL"
                                          | "AOK"
                                          | "RWF"
                                          | "SLE"
                                          | "SIT"
                                          | "VES"
                                          | "ZAL"
                                          | "CNX"
                                          | "XSU"
                                          | "GWE"
                                          | "GYD"
                                          | "BDT"
                                          | "MXN"
                                          | "XCD"
                                          | "GHC"
                                          | "TWD"
                                          | "XBC"
                                          | "CHE"
                                          | "YUR"
                                          | "BSD"
                                          | "DEM"
                                          | "BWP"
                                          | "MAD"
                                          | "RUR"
                                          | "HRK"
                                          | "STN"
                                          | "BUK"
                                          | "MWK"
                                          | "NLG"
                                          | "PLZ"
                                          | "UYU"
                                          | "SBD"
                                          | "EEK"
                                          | "DDM"
                                          | "MKN"
                                          | "MVP"
                                          | "HUF"
                                          | "MXV"
                                          | "KRW"
                                          | "ILS"
                                          | "ARM"
                                          | "YUM"
                                          | "ANG"
                                          | "SRD"
                                          | "CUC"
                                          | "AFN"
                                          | "NIO"
                                          | "IRR"
                                          | "KHR"
                                          | "VED"
                                          | "ECV"
                                          | "SDG"
                                          | "TMM"
                                          | "MTP"
                                          | "NAD"
                                          | "TJR"
                                          | "XBB"
                                          | "STD"
                                          | "XFU"
                                          | "ALL"
                                          | "YUN"
                                          | "BYN"
                                          | "CDF"
                                          | "XAF"
                                          | "BGM"
                                          | "BHD"
                                          | "SDP"
                                          | "AZN"
                                          | "BEC"
                                          | "NPR"
                                          | "KMF"
                                          | "KWD"
                                          | "GMD"
                                          | "BGN"
                                          | "KRO"
                                          | "LBP"
                                          | "LUF"
                                          | "UZS"
                                          | "SCR"
                                          | "YUD"
                                          | "UAH"
                                          | "ESP"
                                          | "ECS"
                                          | "ESA"
                                          | "BGL"
                                          | "ARS"
                                          | "CYP"
                                          | "XUA"
                                          | "BIF"
                                          | "PAB"
                                          | "BZD"
                                          | "USN"
                                          | "HNL";
                                      date: string;
                                      labels_tags?: null
                                      | (...)[];
                                      location:
                                          | null
                                          | {
                                              created: ...;
                                              id: ...;
                                              osm_address_city: ...;
                                              osm_address_country: ...;
                                              osm_address_postcode: ...;
                                              osm_display_name: ...;
                                              osm_id: ...;
                                              osm_lat: ...;
                                              osm_lon: ...;
                                              osm_name: ...;
                                              osm_type: ...;
                                              price_count?: ...;
                                              updated: ...;
                                          };
                                      location_id: null
                                      | number;
                                      location_osm_id: number;
                                      location_osm_type: "NODE" | "WAY" | "RELATION";
                                      origins_tags?: null | (...)[];
                                      owner: string;
                                      price: number;
                                      price_is_discounted?: boolean;
                                      price_per?: null | "UNIT" | "KILOGRAM";
                                      price_without_discount?: null | number;
                                      product:
                                          | null
                                          | {
                                              brands: ...;
                                              code: ...;
                                              created: ...;
                                              id: ...;
                                              image_url: ...;
                                              price_count?: ...;
                                              product_name: ...;
                                              product_quantity: ...;
                                              source: ...;
                                              unique_scans_n?: ...;
                                              updated: ...;
                                          };
                                      product_code?: null
                                      | string;
                                      product_id: null | number;
                                      product_name?: null | string;
                                      proof:
                                          | null
                                          | {
                                              created: ...;
                                              file_path: ...;
                                              id: ...;
                                              is_public?: ...;
                                              mimetype: ...;
                                              owner: ...;
                                              type?: ...;
                                          };
                                      proof_id?: null
                                      | number;
                                  }[];
                                  page: null
                                  | number;
                                  pages?: null | number;
                                  size: null | number;
                                  total: null | number;
                              };
                          };
                      };
                      "422": {
                          content: {
                              "application/json": {
                                  detail?: { loc: (...)[]; msg: string; type: string }[];
                              };
                          };
                      };
                  };
              },
              {
                  params: {
                      query: | undefined
                      | {
                          category_tag?: null
                          | string;
                          created__gte?: null | string;
                          created__lte?: null | string;
                          currency?: null | string;
                          date?: null | string;
                          date__gt?: null | string;
                          date__gte?: null | string;
                          date__lt?: null | string;
                          date__lte?: null | string;
                          labels_tags__like?: null | string;
                          location_id?: null | number;
                          location_osm_id?: null | number;
                          location_osm_type?: null | "NODE" | "WAY" | "RELATION";
                          order_by?: null | string;
                          origins_tags__like?: null | string;
                          owner?: null | string;
                          page?: number;
                          price?: null | number;
                          price__gt?: null | number;
                          price__gte?: null | number;
                          price__lt?: null | number;
                          price__lte?: null | number;
                          price_is_discounted?: null | boolean;
                          product_code?: null | string;
                          product_id?: null | number;
                          product_id__isnull?: null | boolean;
                          size?: number;
                      };
                  };
              },
              `${string}/${string}`,
          >,
      >

    • Returns Promise<
          FetchResponse<
              {
                  parameters: {
                      query?: {
                          order_by?: null
                          | string;
                          owner?: null | string;
                          page?: number;
                          size?: number;
                          type?: null | "PRICE_TAG" | "RECEIPT" | "GDPR_REQUEST";
                      };
                  };
                  responses: {
                      "200": {
                          content: {
                              "application/json": {
                                  items: {
                                      created: string;
                                      file_path: null
                                      | string;
                                      id: number;
                                      is_public?: boolean;
                                      mimetype: string;
                                      owner: string;
                                      type?: null | "PRICE_TAG" | "RECEIPT" | "GDPR_REQUEST";
                                  }[];
                                  page: null
                                  | number;
                                  pages?: null | number;
                                  size: null | number;
                                  total: null | number;
                              };
                          };
                      };
                      "422": {
                          content: {
                              "application/json": {
                                  detail?: { loc: (...)[]; msg: string; type: string }[];
                              };
                          };
                      };
                  };
              },
              | undefined
              | FetchOptions<
                  {
                      parameters: {
                          query?: {
                              order_by?: null
                              | string;
                              owner?: null | string;
                              page?: number;
                              size?: number;
                              type?: null | "PRICE_TAG" | "RECEIPT" | "GDPR_REQUEST";
                          };
                      };
                      responses: {
                          "200": {
                              content: {
                                  "application/json": {
                                      items: {
                                          created: ...;
                                          file_path: ...;
                                          id: ...;
                                          is_public?: ...;
                                          mimetype: ...;
                                          owner: ...;
                                          type?: ...;
                                      }[];
                                      page: null
                                      | number;
                                      pages?: null | number;
                                      size: null | number;
                                      total: null | number;
                                  };
                              };
                          };
                          "422": { content: { "application/json": { detail?: (...)[] } } };
                      };
                  },
              >,
              `${string}/${string}`,
          >,
      >

    • Returns Promise<{ status: string }>

    • Returns Promise<boolean>

    • Parameters

      • body: { password: string; username: string }

      Returns Promise<
          FetchResponse<
              {
                  parameters: { query?: { set_cookie?: boolean } };
                  requestBody: {
                      content: {
                          "application/x-www-form-urlencoded": {
                              client_id?: null | string;
                              client_secret?: null | string;
                              grant_type?: null | string;
                              password: string;
                              scope?: string;
                              username: string;
                          };
                      };
                  };
                  responses: {
                      "200": { content: { "application/json": unknown } };
                      "422": {
                          content: {
                              "application/json": {
                                  detail?: { loc: (...)[]; msg: string; type: string }[];
                              };
                          };
                      };
                  };
              },
              FetchOptions<
                  {
                      parameters: { query?: { set_cookie?: boolean } };
                      requestBody: {
                          content: {
                              "application/x-www-form-urlencoded": {
                                  client_id?: null | string;
                                  client_secret?: null | string;
                                  grant_type?: null | string;
                                  password: string;
                                  scope?: string;
                                  username: string;
                              };
                          };
                      };
                      responses: {
                          "200": { content: { "application/json": unknown } };
                          "422": {
                              content: {
                                  "application/json": {
                                      detail?: { loc: ...; msg: ...; type: ... }[];
                                  };
                              };
                          };
                      };
                  },
              >,
              `${string}/${string}`,
          >,
      >

    • Parameters

      • body: { file: Blob }

      Returns Promise<
          FetchResponse<
              {
                  requestBody: {
                      content: {
                          "multipart/form-data": {
                              file: string;
                              is_public?: boolean;
                              type: "PRICE_TAG"
                              | "RECEIPT"
                              | "GDPR_REQUEST";
                          };
                      };
                  };
                  responses: {
                      "201": {
                          content: {
                              "application/json": {
                                  created: string;
                                  file_path: null
                                  | string;
                                  id: number;
                                  is_public?: boolean;
                                  mimetype: string;
                                  owner: string;
                                  type?: null | "PRICE_TAG" | "RECEIPT" | "GDPR_REQUEST";
                              };
                          };
                      };
                      "422": {
                          content: {
                              "application/json": {
                                  detail?: { loc: (...)[]; msg: string; type: string }[];
                              };
                          };
                      };
                  };
              },
              FetchOptions<
                  {
                      requestBody: {
                          content: {
                              "multipart/form-data": {
                                  file: string;
                                  is_public?: boolean;
                                  type: "PRICE_TAG"
                                  | "RECEIPT"
                                  | "GDPR_REQUEST";
                              };
                          };
                      };
                      responses: {
                          "201": {
                              content: {
                                  "application/json": {
                                      created: string;
                                      file_path: null
                                      | string;
                                      id: number;
                                      is_public?: boolean;
                                      mimetype: string;
                                      owner: string;
                                      type?: null | "PRICE_TAG" | "RECEIPT" | "GDPR_REQUEST";
                                  };
                              };
                          };
                          "422": {
                              content: {
                                  "application/json": {
                                      detail?: { loc: ...; msg: ...; type: ... }[];
                                  };
                              };
                          };
                      };
                  },
              >,
              `${string}/${string}`,
          >,
      >

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods