API Documentation

1. API Overview

The RecipeBridge API allows third parties to integrate RecipeBridge's recipe search functionality. The API Documentation covers all aspects of the RecipeBridge API. If you have any questions, please email [email protected].

2. Limits and Restriction

RecipeBridge sets limits and restrictions to the type and amount of content available via the API on a per user basis. Users have a default max setting of 1,000 API calls per day, per API key. If you need a higher limit, access to additional data, or additional search capabilities please contact us at [email protected]

3. Authentication

Every user is provided with an API Key that they will use as part of each request to the RecipeBridge application.

4. Queries - Recipe Information

Recipesearch, returns search result of people based on criteria of various search inputs.

4.1 Input Parameters

Field Name

Required?

Value

Notes

Method

required

GetRecipes

Will return a set of search results based on search criteria
key required <your api key> This is the key you received from us.

q

required

<query dependent>

Searches for recipes based on URL encoded words in the recipe title.

i

required

<query dependent>

Searches for recipes based on URL encoded ingredients.

NumResults

required

<query dependent>

The number of results requested. (limit 25, if you need more results please contact [email protected]

offset

required

<query dependent >

Specifies where to start fetching results.


4.1. Example Query

An example recipe search: Search for chicken soup recipes that have rice in them.

http://api.recipebridge.com/rest?method=GetRecipes&q=chicken+soup&i=rice&numResults=10&offset=0&key=<yourapikey>

Example Return XML:

4.1.4 Output Paramaters


Group Name

Children Name

Notes

info    
  search The proper name of the search performed.
  totalresults The total number of results matching query.
r    
 

RecipeName

The name of the recipe.
  RecipeUrl A link to the Recipe.
  IngredientList A comma separated list of ingredients.
  Ingredient Count The number of ingredients used in the recipe.
  RecipeThumb A 46x46 thumbnail of the recipe.
  SourceName The name of the recipe's parent site.
 

SourceImage

A link to the recipe’s parent site favicon image.

 



MS Found Country:US image description
Back to top