locations

GET /api/v1/locations

Changed on

Request

  • Base URL
    https://prices.openfoodfacts.org (the document declares no server; this is the origin it was published from)
  • URL
    https://prices.openfoodfacts.org/api/v1/locations
  • Auth
    none declared

Query parameters

order_bystring

Which field to use when ordering the results.

osm_address_city__likestring
osm_address_country__likestring
osm_name__likestring
osm_tag_keystring
osm_tag_valuestring
osm_type'NODE' | 'RELATION' | 'WAY' nullable
  • NODE - NODE
  • WAY - WAY
  • RELATION - RELATION
pageinteger

A page number within the paginated result set.

price_countinteger
price_count__gteinteger
price_count__lteinteger
sizeinteger

Number of results to return per page.

type'ONLINE' | 'OSM'
  • OSM - OSM
  • ONLINE - ONLINE

Response

pageinteger required

Current page number

pagesinteger required

Total number of pages

sizeinteger required

Number of items per page

totalinteger required

Total number of items

Example response

{
  "page": 1,
  "pages": 16,
  "size": 100,
  "total": 1531
}

Changes

    • info

      added the new optional query request parameter osm_tag_key

    • info

      added the new optional query request parameter osm_tag_value

    • info

      added the new optional query request parameter osm_type

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status