{
  "operationId": "Recipe_RecipeSearchRandom",
  "method": "GET",
  "path": "/recipes/top25random",
  "tags": [
    "Recipe"
  ],
  "summary": "Search for recipes. There are many parameters that you can apply. Starting with the most common, use title_kw to search within a title.\r\n            Use any_kw to search across the entire recipe.\r\n            If you'd like to limit by course, set the parameter \"include_primarycat\" to one of (appetizers,bread,breakfast,dessert,drinks,maindish,salad,sidedish,soup,marinades,other).\r\n            If you'd like to exclude a category, set exclude_cat to one or more (comma-separated) list of those categories to exclude.\r\n            If you'd like to include a category, set include_cat to one or more (comma-separated) of those categories to include.\r\n            To explicitly include an ingredient in your search, set the parameter \"include_ing\" to a CSV of up to three ingredients, e.g.:include_ing=mustard,chicken,beef%20tips\r\n            To explicitly exclude an ingredient in your search, set the parameter \"exclude_ing\" to a CSV of up to three ingredients.\r\n            All searches must contain the paging parameters pg and rpp, which are integers, and represent the page number (1-based) and results per page (rpp).\r\n            So, to get the third page of a result set paged with 25 recipes per page, you'd pass pg=3&rpp=25\r\n            If you'd like to target searches to just a single target user's recipes, set userId=the target userId (number).\r\n            Or, you can set username=theirusername\r\n            vtn;vgn;chs;glf;ntf;dyf;sff;slf;tnf;wmf;rmf;cps\r\n            cuisine\r\n            photos\r\n            filter=added,try,favorites,myrecipes\\r\\n\\r\\n\r\n            folder=FolderNameCaseSensitive\r\n            coll=ID of Collection",
  "parameters": [
    {
      "name": "any_kw",
      "in": "query",
      "required": false,
      "description": "Search anywhere in the recipe for the keyword",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "folder",
      "in": "query",
      "required": false,
      "description": "Search in a specific folder name for the authenticated user",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "coll",
      "in": "query",
      "required": false,
      "description": "Limit to a collection ID number",
      "schema": {
        "format": "int32",
        "type": "integer"
      }
    },
    {
      "name": "filter",
      "in": "query",
      "required": false,
      "description": "optionally set to either \"myrecipes\", \"try\", \"favorites\",\"added\" to filter to just the authenticated user's recipe set",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "title_kw",
      "in": "query",
      "required": false,
      "description": "Search just in the recipe title for the keyword",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "userId",
      "in": "query",
      "required": false,
      "description": "Set the target userid to search their public recipes",
      "schema": {
        "format": "int32",
        "type": "integer"
      }
    },
    {
      "name": "username",
      "in": "query",
      "required": false,
      "description": "Set the target username to search their public recipes",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "token",
      "in": "query",
      "required": false,
      "description": "",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "photos",
      "in": "query",
      "required": false,
      "description": "if set to true, limit search results to photos only",
      "schema": {
        "type": "boolean"
      }
    },
    {
      "name": "boostmine",
      "in": "query",
      "required": false,
      "description": "if set to true, boost my own recipes in my folders so they show up high in the list (at the expense of other sort orders)",
      "schema": {
        "type": "boolean"
      }
    },
    {
      "name": "include_cat",
      "in": "query",
      "required": false,
      "description": "integer of the subcategory you'd like to limit searches to (see the /recipe/categories endpoint for available id numbers). For instance, 58 is \"Main Dish > Casseroles\".",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "exclude_cat",
      "in": "query",
      "required": false,
      "description": "like include_cat, set this to an integer to exclude a specific category",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "include_primarycat",
      "in": "query",
      "required": false,
      "description": "csv indicating up to three top-level categories -- valid values are [appetizers,bread,breakfast,desserts,drinks,maindish,salads,sidedish,soups,marinades,other]",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "exclude_primarycat",
      "in": "query",
      "required": false,
      "description": "csv indicating integer values for up to 3 top-level categories -- valid values are 1...11 [appetizers,bread,breakfast,desserts,drinks,maindish,salads,sidedish,soups,marinades,other]",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "include_ing",
      "in": "query",
      "required": false,
      "description": "A CSV representing up to 3 ingredients to include, e.g., tomatoes,corn%20%starch,chicken",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "exclude_ing",
      "in": "query",
      "required": false,
      "description": "A CSV representing up to 3 ingredients to exclude  (Powersearch-capable plan required)",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "cuisine",
      "in": "query",
      "required": false,
      "description": "Limit to a specific cuisine. Cooks can enter anything free-form, but the few dozen preconfigured values are Afghan,African,American,American-South,Asian,Australian,Brazilian,Cajun,Canadian,Caribbean,Chinese,Croatian,Cuban,Dessert,Eastern European,English,French,German,Greek,Hawaiian,Hungarian,India,Indian,Irish,Italian,Japanese,Jewish,Korean,Latin,Mediterranean,Mexican,Middle Eastern,Moroccan,Polish,Russian,Scandanavian,Seafood,Southern,Southwestern,Spanish,Tex-Mex,Thai,Vegan,Vegetarian,Vietnamese",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "db",
      "in": "query",
      "required": false,
      "description": "",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "userset",
      "in": "query",
      "required": false,
      "description": "If set to a given username, it'll force the search to filter to just that username",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "servingsMin",
      "in": "query",
      "required": false,
      "description": "Limit to yield of a given number size or greater. Note that cooks usually enter recipes by Servings, but sometimes they are posted by \"dozen\", etc. This parameter simply specifies the minimum number for that value entered in \"yield.\"",
      "schema": {
        "format": "double",
        "type": "number"
      }
    },
    {
      "name": "totalMins",
      "in": "query",
      "required": false,
      "description": "Optional. If supplied, will restrict results to recipes that can be made in {totalMins} or less. (Convert \"1 hour, 15 minutes\" to 75 before passing in.)",
      "schema": {
        "format": "int32",
        "type": "integer"
      }
    },
    {
      "name": "maxIngredients",
      "in": "query",
      "required": false,
      "description": "Optional. If supplied, will restrict results to recipes that can be made with {maxIngredients} ingredients or less",
      "schema": {
        "format": "int32",
        "type": "integer"
      }
    },
    {
      "name": "minIngredients",
      "in": "query",
      "required": false,
      "description": "Optional. If supplied, will restrict results to recipes that have at least {minIngredients}",
      "schema": {
        "format": "int32",
        "type": "integer"
      }
    },
    {
      "name": "vtn",
      "in": "query",
      "required": false,
      "description": "when set to 1, limit to vegetarian (Powersearch-capable plan required)",
      "schema": {
        "format": "int32",
        "type": "integer"
      }
    },
    {
      "name": "vgn",
      "in": "query",
      "required": false,
      "description": "when set to 1, limit to vegan (Powersearch-capable plan required)",
      "schema": {
        "format": "int32",
        "type": "integer"
      }
    },
    {
      "name": "chs",
      "in": "query",
      "required": false,
      "description": "when set to 1, limit to contains-cheese (Powersearch-capable plan required)",
      "schema": {
        "format": "int32",
        "type": "integer"
      }
    },
    {
      "name": "glf",
      "in": "query",
      "required": false,
      "description": "when set to 1, limit to gluten-free (Powersearch-capable plan required)",
      "schema": {
        "format": "int32",
        "type": "integer"
      }
    },
    {
      "name": "ntf",
      "in": "query",
      "required": false,
      "description": "when set to 1, limit to nut-free (Powersearch-capable plan required)",
      "schema": {
        "format": "int32",
        "type": "integer"
      }
    },
    {
      "name": "dyf",
      "in": "query",
      "required": false,
      "description": "when set to 1, limit to dairy-free (Powersearch-capable plan required)",
      "schema": {
        "format": "int32",
        "type": "integer"
      }
    },
    {
      "name": "sff",
      "in": "query",
      "required": false,
      "description": "when set to 1, limit to seafood-free (Powersearch-capable plan required)",
      "schema": {
        "format": "int32",
        "type": "integer"
      }
    },
    {
      "name": "slf",
      "in": "query",
      "required": false,
      "description": "when set to 1, limit to shellfish-free (Powersearch-capable plan required)",
      "schema": {
        "format": "int32",
        "type": "integer"
      }
    },
    {
      "name": "tnf",
      "in": "query",
      "required": false,
      "description": "when set to 1, limit to tree-nut free (Powersearch-capable plan required)",
      "schema": {
        "format": "int32",
        "type": "integer"
      }
    },
    {
      "name": "wmf",
      "in": "query",
      "required": false,
      "description": "when set to 1, limit to white-meat free (Powersearch-capable plan required)",
      "schema": {
        "format": "int32",
        "type": "integer"
      }
    },
    {
      "name": "rmf",
      "in": "query",
      "required": false,
      "description": "when set to 1, limit to red-meat free (Powersearch-capable plan required)",
      "schema": {
        "format": "int32",
        "type": "integer"
      }
    },
    {
      "name": "cps",
      "in": "query",
      "required": false,
      "description": "when set to 1, recipe contains pasta, set to 0 means contains no pasta (Powersearch-capable plan required)",
      "schema": {
        "format": "int32",
        "type": "integer"
      }
    },
    {
      "name": "champion",
      "in": "query",
      "required": false,
      "description": "optional. When set to 1, this will limit search results to \"best of\" recipes as determined by various internal editorial and programmatic algorithms. For the most comprehensive results, don't include this parameter.",
      "schema": {
        "format": "int32",
        "type": "integer"
      }
    },
    {
      "name": "synonyms",
      "in": "query",
      "required": false,
      "description": "optional, default is false. When set to true, BigOven will attempt to apply synonyms in search (e.g., excluding pork will also exclude bacon)",
      "schema": {
        "type": "boolean"
      }
    }
  ],
  "response": {
    "status": 200,
    "contentType": "application/json",
    "schema": {
      "$ref": "#/components/schemas/BigOven.Model.API2.RecipeSearchResult"
    }
  }
}