BigOven

BigOven GroceryList API

The GroceryList API from BigOven — 8 operation(s) for grocerylist.

GitHub OpenAPI

Operations 10

DELETE /grocerylist Delete all the items on a grocery list; faster operation than a sync with… #
GET /grocerylist Get the user's grocery list. User is determined by Basic Authentication #
POST /grocerylist/clearcheckedlines Clears the checked lines #
POST /grocerylist/department Departmentalize a list of strings -- used for ad-hoc grocery list item addition #
POST /grocerylist/item Add a single line item to the grocery list #
DELETE /grocerylist/item/{guid} /grocerylist/item/{guid} DELETE will delete this item assuming you own it #
PUT /grocerylist/item/{guid} Update a grocery item by GUID #
POST /grocerylist/line Add a single line item to the grocery list #
POST /grocerylist/recipe Add a Recipe to the grocery list. #
POST /grocerylist/sync Synchronize the grocery list. Call this with a POST to /grocerylist/sync #

Documentation

📖
Documentation
https://api2.bigoven.com/web/documentation
📖
Authentication
https://api2.bigoven.com/web/documentation/authentication
📖
RateLimits
https://api2.bigoven.com/web/documentation/usage-throttling

Specifications

⚙
OpenAPI
https://artifacts.apis.io/bigoven/openapi/bigoven-grocerylist-api-openapi.yml

Other Resources

🔗
Pricing
https://api2.bigoven.com/web/documentation/feestructure

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/bigoven:bigoven-grocerylist-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

bigoven-grocerylist-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: '#Documentation


    This is the documentation for the partner endpoint of the BigOven Recipe and Grocery List API.'
  title: 1,000,000+ Recipe and API (v2) Grocery List API
  version: partner
  x-apiClientRegistration:
    url: http://api2.bigoven.com/web/console
  x-logo:
    url: https://twitter.com/bigoven/profile_image?size=original
  x-origin:
  - format: openapi
    url: http://api2.bigoven.com/swagger/docs/partner
    version: '3.0'
  x-providerName: bigoven.com
servers:
- url: https://api2.bigoven.com
tags:
- name: GroceryList
paths:
  /grocerylist:
    delete:
      deprecated: false
      operationId: GroceryList_Delete
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/System.Object'
            application/xml:
              schema:
                $ref: '#/components/schemas/System.Object'
            text/json:
              schema:
                $ref: '#/components/schemas/System.Object'
            text/xml:
              schema:
                $ref: '#/components/schemas/System.Object'
          description: OK
      summary: Delete all the items on a grocery list; faster operation than a sync with…
      tags:
      - GroceryList
    get:
      deprecated: false
      operationId: GroceryList_Get
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BigOven.Model.API2.GroceryList'
            application/xml:
              schema:
                $ref: '#/components/schemas/BigOven.Model.API2.GroceryList'
            text/json:
              schema:
                $ref: '#/components/schemas/BigOven.Model.API2.GroceryList'
            text/xml:
              schema:
                $ref: '#/components/schemas/BigOven.Model.API2.GroceryList'
          description: OK
      summary: Get the user's grocery list. User is determined by Basic Authentication
      tags:
      - GroceryList
  /grocerylist/clearcheckedlines:
    post:
      deprecated: false
      operationId: GroceryList_GroceryListRemoveMarkedItems
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BigOven.Model.API2.GroceryList'
            application/xml:
              schema:
                $ref: '#/components/schemas/BigOven.Model.API2.GroceryList'
            text/json:
              schema:
                $ref: '#/components/schemas/BigOven.Model.API2.GroceryList'
            text/xml:
              schema:
                $ref: '#/components/schemas/BigOven.Model.API2.GroceryList'
          description: OK
      summary: Clears the checked lines
      tags:
      - GroceryList
  /grocerylist/department:
    post:
      deprecated: false
      operationId: GroceryList_Department
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/API2.Controllers.WebAPI.GroceryListController.DepartmentModel'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/API2.Controllers.WebAPI.GroceryListController.DepartmentModel'
          application/xml:
            schema:
              $ref: '#/components/schemas/API2.Controllers.WebAPI.GroceryListController.DepartmentModel'
          text/json:
            schema:
              $ref: '#/components/schemas/API2.Controllers.WebAPI.GroceryListController.DepartmentModel'
          text/xml:
            schema:
              $ref: '#/components/schemas/API2.Controllers.WebAPI.GroceryListController.DepartmentModel'
        description: see DepartmentModel for the request payload
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/API2.GroceryListDepartmentResult'
                type: array
            application/xml:
              schema:
                items:
                  $ref: '#/components/schemas/API2.GroceryListDepartmentResult'
                type: array
            text/json:
              schema:
                items:
                  $ref: '#/components/schemas/API2.GroceryListDepartmentResult'
                type: array
            text/xml:
              schema:
                items:
                  $ref: '#/components/schemas/API2.GroceryListDepartmentResult'
                type: array
          description: OK
      summary: Departmentalize a list of strings -- used for ad-hoc grocery list item addition
      tags:
      - GroceryList
  /grocerylist/item:
    post:
      deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/API2.Controllers.WebAPI.GroceryListController.PostToGroceryListRecipeRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/API2.Controllers.WebAPI.GroceryListController.PostToGroceryListRecipeRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/API2.Controllers.WebAPI.GroceryListController.PostToGroceryListRecipeRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/API2.Controllers.WebAPI.GroceryListController.PostToGroceryListRecipeRequest'
          text/xml:
            schema:
              $ref: '#/components/schemas/API2.Controllers.WebAPI.GroceryListController.PostToGroceryListRecipeRequest'
        description: name, quantity, unit, notes, department
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BigOven.Model.ShoppingListLine'
            application/xml:
              schema:
                $ref: '#/components/schemas/BigOven.Model.ShoppingListLine'
            text/json:
              schema:
                $ref: '#/components/schemas/BigOven.Model.ShoppingListLine'
            text/xml:
              schema:
                $ref: '#/components/schemas/BigOven.Model.ShoppingListLine'
          description: OK
      summary: Add a single line item to the grocery list
      tags:
      - GroceryList
      operationId: postGrocerylistItem
      x-operation-id-source: derived
  /grocerylist/item/{guid}:
    delete:
      deprecated: false
      operationId: GroceryList_DeleteItemByGuid
      parameters:
      - description: ''
        in: path
        name: guid
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/System.Object'
            application/xml:
              schema:
                $ref: '#/components/schemas/System.Object'
            text/json:
              schema:
                $ref: '#/components/schemas/System.Object'
            text/xml:
              schema:
                $ref: '#/components/schemas/System.Object'
          description: OK
      summary: /grocerylist/item/{guid} DELETE will delete this item assuming you own it
      tags:
      - GroceryList
    put:
      deprecated: false
      operationId: GroceryList_GroceryListItemGuid
      parameters:
      - in: path
        name: guid
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/API2.Controllers.WebAPI.GroceryListController.UpdateItemByGuidRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/API2.Controllers.WebAPI.GroceryListController.UpdateItemByGuidRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/API2.Controllers.WebAPI.GroceryListController.UpdateItemByGuidRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/API2.Controllers.WebAPI.GroceryListController.UpdateItemByGuidRequest'
          text/xml:
            schema:
              $ref: '#/components/schemas/API2.Controllers.WebAPI.GroceryListController.UpdateItemByGuidRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/System.Object'
            application/xml:
              schema:
                $ref: '#/components/schemas/System.Object'
            text/json:
              schema:
                $ref: '#/components/schemas/System.Object'
            text/xml:
              schema:
                $ref: '#/components/schemas/System.Object'
          description: OK
      summary: Update a grocery item by GUID
      tags:
      - GroceryList
  /grocerylist/line:
    post:
      deprecated: false
      operationId: GroceryList_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/API2.Controllers.WebAPI.GroceryListController.PostGroceryListAddLineRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/API2.Controllers.WebAPI.GroceryListController.PostGroceryListAddLineRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/API2.Controllers.WebAPI.GroceryListController.PostGroceryListAddLineRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/API2.Controllers.WebAPI.GroceryListController.PostGroceryListAddLineRequest'
          text/xml:
            schema:
              $ref: '#/components/schemas/API2.Controllers.WebAPI.GroceryListController.PostGroceryListAddLineRequest'
        description: name, quantity, unit, notes, department
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BigOven.Model.ShoppingListLine'
            application/xml:
              schema:
                $ref: '#/components/schemas/BigOven.Model.ShoppingListLine'
            text/json:
              schema:
                $ref: '#/components/schemas/BigOven.Model.ShoppingListLine'
            text/xml:
              schema:
                $ref: '#/components/schemas/BigOven.Model.ShoppingListLine'
          description: OK
      summary: Add a single line item to the grocery list
      tags:
      - GroceryList
  /grocerylist/recipe:
    post:
      deprecated: false
      operationId: GroceryList_AddRecipe
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/API2.Controllers.WebAPI.GroceryListController.PostGroceryListRecipeRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/API2.Controllers.WebAPI.GroceryListController.PostGroceryListRecipeRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/API2.Controllers.WebAPI.GroceryListController.PostGroceryListRecipeRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/API2.Controllers.WebAPI.GroceryListController.PostGroceryListRecipeRequest'
          text/xml:
            schema:
              $ref: '#/components/schemas/API2.Controllers.WebAPI.GroceryListController.PostGroceryListRecipeRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/System.Object'
            application/xml:
              schema:
                $ref: '#/components/schemas/System.Object'
            text/json:
              schema:
                $ref: '#/components/schemas/System.Object'
            text/xml:
              schema:
                $ref: '#/components/schemas/System.Object'
          description: OK
      summary: Add a Recipe to the grocery list.
      tags:
      - GroceryList
  /grocerylist/sync:
    post:
      deprecated: false
      operationId: GroceryList_PostGroceryListSync
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/API2.Controllers.WebAPI.GroceryListController.PostGroceryListSyncRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/API2.Controllers.WebAPI.GroceryListController.PostGroceryListSyncRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/API2.Controllers.WebAPI.GroceryListController.PostGroceryListSyncRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/API2.Controllers.WebAPI.GroceryListController.PostGroceryListSyncRequest'
          text/xml:
            schema:
              $ref: '#/components/schemas/API2.Controllers.WebAPI.GroceryListController.PostGroceryListSyncRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/System.Object'
            application/xml:
              schema:
                $ref: '#/components/schemas/System.Object'
            text/json:
              schema:
                $ref: '#/components/schemas/System.Object'
            text/xml:
              schema:
                $ref: '#/components/schemas/System.Object'
          description: OK
      summary: Synchronize the grocery list. Call this with a POST to /grocerylist/sync
      tags:
      - GroceryList
components:
  schemas:
    BigOven.Model.API.UserInfo:
      properties:
        FirstName:
          type: string
        ImageUrl48:
          type: string
        IsKitchenHelper:
          type: boolean
        IsPremium:
          type: boolean
        IsUsingRecurly:
          type: boolean
        LastName:
          type: string
        MemberSince:
          format: date-time
          type: string
        PhotoUrl:
          type: string
        PhotoUrl48:
          readOnly: true
          type: string
        PremiumExpiryDate:
          format: date-time
          type: string
        UserID:
          format: int32
          type: integer
        UserName:
          type: string
        WebUrl:
          readOnly: true
          type: string
      type: object
    API2.GroceryListDepartmentResult:
      description: ''
      properties:
        dept:
          description: Gets or sets the dept.
          type: string
        item:
          description: Gets or sets the item.
          type: string
      type: object
    API2.Controllers.WebAPI.GroceryListController.PostGroceryListSyncRequest:
      description: ''
      properties:
        list:
          $ref: '#/components/schemas/BigOven.Model.API.Grocery.GroceryList'
        since:
          description: Gets or sets the since.
          type: string
      type: object
    BigOven.Model.API.Grocery.GroceryList:
      properties:
        Items:
          items:
            $ref: '#/components/schemas/BigOven.Model.API.Grocery.Item'
          type: array
        LastModified:
          format: date-time
          type: string
        Recipes:
          items:
            $ref: '#/components/schemas/BigOven.Model.API.RecipeInfo'
          type: array
        VersionGuid:
          type: string
      type: object
    BigOven.Model.ShoppingListLine:
      properties:
        DateAdded:
          format: date-time
          type: string
        Dept:
          type: string
        GUID:
          type: string
        HTMLItemName:
          type: string
        IsChecked:
          type: boolean
        ItemName:
          type: string
        LastModified:
          format: date-time
          type: string
        ListID:
          format: int64
          type: integer
        MealPlanID:
          format: int32
          type: integer
        MealPlanObjectType:
          format: int32
          type: integer
        Notes:
          type: string
        PendingAddition:
          type: boolean
        RecipeID:
          format: int32
          type: integer
        ShoppingListLineID:
          format: int64
          type: integer
        Store:
          type: string
        TextAmt:
          type: string
        ThirdPartyHost:
          type: string
        ThirdPartyTitle:
          type: string
        ThirdPartyURL:
          type: string
      type: object
    BigOven.Model.API2.RecipeInfox:
      properties:
        Category:
          type: string
        CreationDate:
          format: date-time
          type: string
        Cuisine:
          type: string
        HasVideos:
          type: boolean
        IsBookmark:
          type: boolean
        IsPrivate:
          type: boolean
        IsRecipeScan:
          type: boolean
        Microcategory:
          type: string
        PhotoUrl:
          type: string
        Poster:
          $ref: '#/components/schemas/BigOven.Model.API2.UserInfoTinyx'
        RecipeID:
          format: int32
          type: integer
        ReviewCount:
          format: int32
          type: integer
        Servings:
          format: double
          type: number
        StarRating:
          format: double
          type: number
        Subcategory:
          type: string
        Title:
          type: string
        TotalTries:
          format: int32
          type: integer
        WebURL:
          type: string
      type: object
    API2.Controllers.WebAPI.GroceryListController.DepartmentModel:
      description: ''
      properties:
        items:
          description: Gets or sets the items.
          type: string
      type: object
    BigOven.Model.API2.GroceryList:
      properties:
        Items:
          items:
            $ref: '#/components/schemas/BigOven.Model.API.Grocery.Item'
          type: array
        LastModified:
          format: date-time
          type: string
        Recipes:
          items:
            $ref: '#/components/schemas/BigOven.Model.API2.RecipeInfox'
          type: array
        VersionGuid:
          type: string
      type: object
    API2.Controllers.WebAPI.GroceryListController.PostGroceryListRecipeRequest:
      description: ''
      properties:
        markAsPending:
          description: Gets or sets the mark as pending.
          type: boolean
        recipeId:
          description: Gets or sets the recipe identifier.
          format: int32
          type: integer
        scale:
          description: Gets or sets the scale.
          format: double
          type: number
      type: object
    System.Object:
      properties: {}
      type: object
    BigOven.Model.API.RecipeInfo:
      properties:
        BookmarkURL:
          type: string
        Category:
          type: string
        CreationDate:
          format: date-time
          type: string
        Cuisine:
          type: string
        HasVideos:
          type: boolean
        HeroPhotoUrl:
          type: string
        HideFromPublicSearch:
          type: boolean
        ImageURL:
          type: string
        ImageURL120:
          type: string
        IsBookmark:
          type: boolean
        IsPrivate:
          type: boolean
        MaxImageSquare:
          format: int32
          type: integer
        Microcategory:
          type: string
        Poster:
          $ref: '#/components/schemas/BigOven.Model.API.UserInfo'
        QualityScore:
          format: double
          type: number
        RecipeID:
          format: int32
          type: integer
        ReviewCount:
          format: int32
          type: integer
        StarRating:
          format: double
          type: number
        StarRatingIMG:
          type: string
        Subcategory:
          type: string
        Title:
          type: string
        TotalTries:
          format: int32
          type: integer
        WebURL:
          type: string
        YieldNumber:
          format: double
          type: number
      type: object
    BigOven.Model.API.Grocery.Item:
      properties:
        BigOvenObject:
          type: string
        CreationDate:
          format: date-time
          type: string
        Department:
          type: string
        DisplayQuantity:
          type: string
        GUID:
          type: string
        IsChecked:
          type: boolean
        ItemID:
          format: int64
          type: integer
        LastModified:
          format: date-time
          type: string
        LocalStatus:
          type: string
        Name:
          type: string
        Notes:
          type: string
        RecipeID:
          format: int32
          type: integer
        ThirdPartyURL:
          type: string
      type: object
    API2.Controllers.WebAPI.GroceryListController.PostToGroceryListRecipeRequest:
      description: ''
      properties:
        department:
          description: Gets or sets the department.
          type: string
        name:
          description: Gets or sets the name.
          type: string
        notes:
          description: Gets or sets the notes.
          type: string
        quantity:
          description: Gets or sets the quantity.
          type: string
        unit:
          description: Gets or sets the unit.
          type: string
      type: object
    BigOven.Model.API2.UserInfoTinyx:
      properties:
        FirstName:
          type: string
        LastName:
          type: string
        PhotoUrl:
          type: string
        UserID:
          format: int32
          type: integer
        UserName:
          type: string
      type: object
    API2.Controllers.WebAPI.GroceryListController.PostGroceryListAddLineRequest:
      description: ''
      properties:
        text:
          description: Gets or sets the text.
          type: string
      type: object
    API2.Controllers.WebAPI.GroceryListController.UpdateItemByGuidRequest:
      description: ''
      properties:
        department:
          description: Gets or sets the department.
          type: string
        guid:
          description: Gets or sets the unique identifier.
          type: string
        ischecked:
          description: Gets or sets the ischecked.
          type: boolean
        name:
          description: Gets or sets the name.
          type: string
        notes:
          description: Gets or sets the notes.
          type: string
        quantity:
          description: Gets or sets the quantity.
          type: string
        unit:
          description: Gets or sets the unit.
          type: string
      type: object
  securitySchemes:
    api_key:
      description: 'Pass your api_key in the header (recommended) or as a URL parameter. For the URL parameter, use api_key. For the header, send it as a header value for: X-BigOven-API-Key'
      in: header
      name: X-BigOven-API-Key
      type: apiKey
    basic:
      description: Basic HTTP Authentication is used for those endpoint calls where you want to act as a BigOven user -- e.g., to get the list of favorites of a signed-in user, or add items to their grocery list.
      scheme: basic
      type: http
externalDocs:
  url: http://api2.bigoven.com/web/documentation
x-provenance:
  method: harvested
  publisher: BigOven
  source: https://api2.bigoven.com/swagger/docs/partner
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)