APIVerve.API.Cocktail 1.0.3

There is a newer version of this package available.
See the version list below for details.
dotnet add package APIVerve.API.Cocktail --version 1.0.3                
NuGet\Install-Package APIVerve.API.Cocktail -Version 1.0.3                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="APIVerve.API.Cocktail" Version="1.0.3" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add APIVerve.API.Cocktail --version 1.0.3                
#r "nuget: APIVerve.API.Cocktail, 1.0.3"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install APIVerve.API.Cocktail as a Cake Addin
#addin nuget:?package=APIVerve.API.Cocktail&version=1.0.3

// Install APIVerve.API.Cocktail as a Cake Tool
#tool nuget:?package=APIVerve.API.Cocktail&version=1.0.3                

Cocktail API

Cocktail is a simple tool for getting cocktail recipes. It returns the ingredients, instructions, and more of the cocktail.

Build Status Code Climate Prod Ready

This is a .NET Wrapper for the Cocktail API


Installation

Using the .NET CLI:

dotnet add package APIVerve.API.Cocktail

Using the Package Manager:

nuget install APIVerve.API.Cocktail

Using the Package Manager Console:

Install-Package APIVerve.API.Cocktail

From within Visual Studio:

  1. Open the Solution Explorer.
  2. Right-click on a project within your solution.
  3. Click on Manage NuGet Packages...
  4. Click on the Browse tab and search for "APIVerve.API.Cocktail".
  5. Click on the APIVerve.API.Cocktail package, select the appropriate version in the right-tab and click Install.

Configuration

Before using the cocktail API client, you have to setup your account and obtain your API Key.
You can get it by signing up at https://apiverve.com


Usage

The Cocktail API documentation is found here: https://docs.apiverve.com/api/cocktail.
You can find parameters, example responses, and status codes documented here.

Setup

Authentication

Cocktail API uses API Key-based authentication. When you create an instance of the API client, you can pass your API Key as a parameter.

// Create an instance of the API client
var apiClient = new CocktailAPIClient("[YOUR_API_KEY]", true);

Perform Request

Using the API client, you can perform requests to the API.

Define Query
var queryOptions = new cocktailQueryOptions {
  name = "martini",
  ingredient = "gin"
};
Simple Request
var response = apiClient.Execute(queryOptions);
if(response.Error != null) {
	Console.WriteLine(response.Error);
} else {
    var json = JsonConvert.SerializeObject(response.Data, Newtonsoft.Json.Formatting.Indented);
    Console.WriteLine(response.Data);
}
Example Response
{
  "status": "ok",
  "error": null,
  "data": {
    "count": 22,
    "filteredOn": "ingredient",
    "cocktails": [
      {
        "name": "Vesper",
        "glass": "martini",
        "category": "Before Dinner Cocktail",
        "ingredients": [
          {
            "unit": "cl",
            "amount": 6,
            "ingredient": "Gin"
          },
          {
            "unit": "cl",
            "amount": 1.5,
            "ingredient": "Vodka"
          },
          {
            "unit": "cl",
            "amount": 0.75,
            "ingredient": "Lillet Blonde"
          }
        ],
        "garnish": "Lemon twist",
        "preparation": "Shake and strain into a chilled cocktail glass."
      },
      {
        "name": "Negroni",
        "glass": "old-fashioned",
        "category": "Before Dinner Cocktail",
        "ingredients": [
          {
            "unit": "cl",
            "amount": 3,
            "ingredient": "Gin"
          },
          {
            "unit": "cl",
            "amount": 3,
            "ingredient": "Campari"
          },
          {
            "unit": "cl",
            "amount": 3,
            "ingredient": "Vermouth",
            "label": "Sweet red vermouth"
          }
        ],
        "garnish": "Half an orange slice",
        "preparation": "Build into old-fashioned glass filled with ice. Stir gently."
      },
      {
        "name": "Tuxedo",
        "glass": "martini",
        "category": "All Day Cocktail",
        "ingredients": [
          {
            "unit": "cl",
            "amount": 3,
            "ingredient": "Gin",
            "label": "Old Tom Gin"
          },
          {
            "unit": "cl",
            "amount": 3,
            "ingredient": "Vermouth",
            "label": "Dry vermouth"
          },
          {
            "special": "1/2 bar spoon Maraschino"
          },
          {
            "special": "1/4 bar spoon Absinthe"
          },
          {
            "special": "3 dashes Orange Bitters"
          }
        ],
        "garnish": "Cherry and lemon twist",
        "preparation": "Stir all ingredients with ice and strain into cocktail glass."
      },
      {
        "name": "Horse's Neck",
        "glass": "highball",
        "category": "Longdrink",
        "ingredients": [
          {
            "unit": "cl",
            "amount": 4,
            "ingredient": "Cognac"
          },
          {
            "unit": "cl",
            "amount": 12,
            "ingredient": "Ginger Ale"
          },
          {
            "special": "Dash of Angostura bitters (optional)"
          }
        ],
        "garnish": "Lemon twist",
        "preparation": "Build into highball glass with ice cubes. Stir gently. If required, add dashes of Angostura bitters."
      },
      {
        "name": "Long Island Iced Tea",
        "glass": "highball",
        "category": "Longdrink",
        "ingredients": [
          {
            "unit": "cl",
            "amount": 1.5,
            "ingredient": "Tequila"
          },
          {
            "unit": "cl",
            "amount": 1.5,
            "ingredient": "Vodka"
          },
          {
            "unit": "cl",
            "amount": 1.5,
            "ingredient": "White rum"
          },
          {
            "unit": "cl",
            "amount": 1.5,
            "ingredient": "Triple Sec"
          },
          {
            "unit": "cl",
            "amount": 1.5,
            "ingredient": "Gin"
          },
          {
            "unit": "cl",
            "amount": 2.5,
            "ingredient": "Lemon juice"
          },
          {
            "unit": "cl",
            "amount": 3,
            "ingredient": "Syrup",
            "label": "Gomme syrup"
          },
          {
            "special": "1 dash of Cola"
          }
        ],
        "garnish": "Lemon twist",
        "preparation": "Add all ingredients into highball glass filled with ice. Stir gently. Serve with straw."
      },
      {
        "name": "Clover Club",
        "glass": "martini",
        "category": "All Day Cocktail",
        "ingredients": [
          {
            "unit": "cl",
            "amount": 4.5,
            "ingredient": "Gin"
          },
          {
            "unit": "cl",
            "amount": 1.5,
            "ingredient": "Syrup",
            "label": "Raspberry syrup"
          },
          {
            "unit": "cl",
            "amount": 1.5,
            "ingredient": "Lemon juice"
          },
          {
            "special": "Few drops of Egg White"
          }
        ],
        "preparation": "Shake with ice cubes. Strain into cocktail glass."
      },
      {
        "name": "Angel Face",
        "glass": "martini",
        "category": "All Day Cocktail",
        "ingredients": [
          {
            "unit": "cl",
            "amount": 3,
            "ingredient": "Gin"
          },
          {
            "unit": "cl",
            "amount": 3,
            "ingredient": "Apricot brandy"
          },
          {
            "unit": "cl",
            "amount": 3,
            "ingredient": "Calvados"
          }
        ],
        "preparation": "Shake with ice cubes. Strain into a cocktail glass."
      },
      {
        "name": "Gin Fizz",
        "glass": "highball",
        "category": "Longdrink",
        "ingredients": [
          {
            "unit": "cl",
            "amount": 4.5,
            "ingredient": "Gin"
          },
          {
            "unit": "cl",
            "amount": 3,
            "ingredient": "Lemon juice"
          },
          {
            "unit": "cl",
            "amount": 1,
            "ingredient": "Syrup",
            "label": "Sugar syrup"
          },
          {
            "unit": "cl",
            "amount": 8,
            "ingredient": "Soda water"
          }
        ],
        "garnish": "Lemon slice",
        "preparation": "Shake all ingredients with ice cubes, except soda water. Pour into tumbler. Top with soda water."
      },
      {
        "name": "French 75",
        "glass": "champagne-tulip",
        "category": "Sparkling Cocktail",
        "ingredients": [
          {
            "unit": "cl",
            "amount": 3,
            "ingredient": "Gin"
          },
          {
            "unit": "cl",
            "amount": 1.5,
            "ingredient": "Lemon juice"
          },
          {
            "special": "2 dashes Sugar syrup"
          },
          {
            "unit": "cl",
            "amount": 6,
            "ingredient": "Champagne"
          }
        ],
        "preparation": "Shake with ice cubes, except for champagne. Strain into a champagne flute. Top up with champagne. Stir gently."
      },
      {
        "name": "Aviation",
        "glass": "martini",
        "category": "All Day Cocktail",
        "ingredients": [
          {
            "unit": "cl",
            "amount": 4.5,
            "ingredient": "Gin"
          },
          {
            "unit": "cl",
            "amount": 1.5,
            "ingredient": "Cherry liqueur",
            "label": "Maraschino"
          },
          {
            "unit": "cl",
            "amount": 1.5,
            "ingredient": "Lemon juice"
          }
        ],
        "preparation": "Shake and strain into a chilled cocktail glass."
      },
      {
        "name": "Bramble",
        "glass": "old-fashioned",
        "category": "All Day Cocktail",
        "ingredients": [
          {
            "unit": "cl",
            "amount": 4,
            "ingredient": "Gin"
          },
          {
            "unit": "cl",
            "amount": 1.5,
            "ingredient": "Lemon juice"
          },
          {
            "unit": "cl",
            "amount": 1,
            "ingredient": "Syrup",
            "label": "Sugar syrup"
          },
          {
            "unit": "cl",
            "amount": 1.5,
            "ingredient": "Blackberry liqueur"
          }
        ],
        "garnish": "Lemon slice and two blackberries",
        "preparation": "Build over crushed ice, in a rock glass. Stir, then pour the blackberry liqueur over the top of the drink in a circular fashion."
      },
      {
        "name": "Monkey Gland",
        "glass": "martini",
        "category": "All Day Cocktail",
        "ingredients": [
          {
            "unit": "cl",
            "amount": 5,
            "ingredient": "Gin"
          },
          {
            "unit": "cl",
            "amount": 3,
            "ingredient": "Orange juice"
          },
          {
            "special": "2 drops Absinthe"
          },
          {
            "special": "2 drops Grenadine"
          }
        ],
        "preparation": "Shake and strain into a chilled cocktail glass."
      },
      {
        "name": "Derby",
        "glass": "martini",
        "category": "All Day Cocktail",
        "ingredients": [
          {
            "unit": "cl",
            "amount": 6,
            "ingredient": "Gin"
          },
          {
            "special": "2 drops Peach Bitters"
          },
          {
            "special": "2 Fresh mint leaves"
          }
        ],
        "garnish": "Mint leaves",
        "preparation": "Stir in mixing glass with ice cubes. Strain into a cocktail glass."
      },
      {
        "name": "Singapore Sling",
        "glass": "highball",
        "category": "Longdrink",
        "ingredients": [
          {
            "unit": "cl",
            "amount": 3,
            "ingredient": "Gin"
          },
          {
            "unit": "cl",
            "amount": 1.5,
            "ingredient": "Cherry liqueur"
          },
          {
            "unit": "cl",
            "amount": 0.75,
            "ingredient": "Triple Sec",
            "label": "Cointreau"
          },
          {
            "unit": "cl",
            "amount": 0.75,
            "ingredient": "DOM Bénédictine"
          },
          {
            "unit": "cl",
            "amount": 12,
            "ingredient": "Pineapple juice"
          },
          {
            "unit": "cl",
            "amount": 1.5,
            "ingredient": "Lime juice"
          },
          {
            "unit": "cl",
            "amount": 1,
            "ingredient": "Syrup",
            "label": "Grenadine"
          },
          {
            "special": "1 dash Angostura bitters"
          }
        ],
        "garnish": "Pineapple slice and a cherry",
        "preparation": "Shake with ice cubes. Strain into highball glass."
      },
      {
        "name": "Moscow Mule",
        "glass": "highball",
        "category": "Longdrink",
        "ingredients": [
          {
            "unit": "cl",
            "amount": 4.5,
            "ingredient": "Vodka"
          },
          {
            "unit": "cl",
            "amount": 12,
            "ingredient": "Ginger beer"
          },
          {
            "unit": "cl",
            "amount": 0.5,
            "ingredient": "Lime juice"
          },
          {
            "special": "1 slice lime in a highball glass"
          }
        ],
        "garnish": "Lime slice",
        "preparation": "Combine the vodka and ginger beer. Add lime juice."
      },
      {
        "name": "John Collins",
        "glass": "highball",
        "category": "Longdrink",
        "ingredients": [
          {
            "unit": "cl",
            "amount": 4.5,
            "ingredient": "Gin"
          },
          {
            "unit": "cl",
            "amount": 3,
            "ingredient": "Lemon juice"
          },
          {
            "unit": "cl",
            "amount": 1.5,
            "ingredient": "Syrup",
            "label": "Sugar syrup"
          },
          {
            "unit": "cl",
            "amount": 6,
            "ingredient": "Soda water"
          }
        ],
        "garnish": "Lemon slice and a cherry",
        "preparation": "Build into highball glass filled with ice. Stir gently. Add a dash of Angostura bitters. (Note: Use Old Tom Gin for Tom Collins)"
      },
      {
        "name": "Paradise",
        "glass": "martini",
        "category": "All Day Cocktail",
        "ingredients": [
          {
            "unit": "cl",
            "amount": 3.5,
            "ingredient": "Gin"
          },
          {
            "unit": "cl",
            "amount": 2,
            "ingredient": "Apricot brandy"
          },
          {
            "unit": "cl",
            "amount": 1.5,
            "ingredient": "Orange juice"
          }
        ],
        "preparation": "Shake with ice cubes. Strain into chilled cocktail glass."
      },
      {
        "name": "Dark 'n' Stormy",
        "glass": "highball",
        "category": "Longdrink",
        "ingredients": [
          {
            "unit": "cl",
            "amount": 6,
            "ingredient": "Dark rum"
          },
          {
            "unit": "cl",
            "amount": 10,
            "ingredient": "Ginger beer"
          }
        ],
        "garnish": "Lime wedge",
        "preparation": "Build into highball glass filled with ice. Add rum first and top it with ginger beer."
      },
      {
        "name": "Ramos Fizz",
        "glass": "highball",
        "category": "Longdrink",
        "ingredients": [
          {
            "unit": "cl",
            "amount": 4.5,
            "ingredient": "Gin"
          },
          {
            "unit": "cl",
            "amount": 1.5,
            "ingredient": "Lime juice"
          },
          {
            "unit": "cl",
            "amount": 1.5,
            "ingredient": "Lemon juice"
          },
          {
            "unit": "cl",
            "amount": 3,
            "ingredient": "Syrup",
            "label": "Sugar syrup"
          },
          {
            "unit": "cl",
            "amount": 6,
            "ingredient": "Cream"
          },
          {
            "special": "1 Egg white"
          },
          {
            "special": "3 dashes Orange flower water"
          },
          {
            "special": "2 drops Vanilla extract"
          },
          {
            "special": "Soda water"
          }
        ],
        "preparation": "Pour all ingredients (except soda) in a mixing glass, dry shake (no ice) for two minutes, add ice and hard shake for another minute. Strain into a highball glass without ice, top with soda."
      },
      {
        "name": "Dry Martini",
        "glass": "martini",
        "category": "Before Dinner Cocktail",
        "ingredients": [
          {
            "unit": "cl",
            "amount": 6,
            "ingredient": "Gin"
          },
          {
            "unit": "cl",
            "amount": 1,
            "ingredient": "Vermouth",
            "label": "Dry vermouth"
          }
        ],
        "preparation": "Stir in mixing glass with ice cubes. Strain into chilled martini glass. Squeeze oil from lemon peel onto the drink, or garnish with olive."
      },
      {
        "name": "Casino",
        "glass": "martini",
        "category": "All Day Cocktail",
        "ingredients": [
          {
            "unit": "cl",
            "amount": 4,
            "ingredient": "Gin",
            "label": "Old Tom Gin"
          },
          {
            "unit": "cl",
            "amount": 1,
            "ingredient": "Cherry liqueur",
            "label": "Maraschino"
          },
          {
            "unit": "cl",
            "amount": 1,
            "ingredient": "Orange Bitters"
          },
          {
            "unit": "cl",
            "amount": 1,
            "ingredient": "Lemon juice"
          }
        ],
        "garnish": "Lemon twist and a cherry",
        "preparation": "Shake with ice cubes. Strain into chilled cocktail glass."
      },
      {
        "name": "White Lady",
        "glass": "martini",
        "category": "All Day Cocktail",
        "ingredients": [
          {
            "unit": "cl",
            "amount": 4,
            "ingredient": "Gin"
          },
          {
            "unit": "cl",
            "amount": 3,
            "ingredient": "Triple Sec"
          },
          {
            "unit": "cl",
            "amount": 2,
            "ingredient": "Lemon juice"
          }
        ],
        "preparation": "Shake with ice cubes. Strain into large cocktail glass."
      }
    ]
  }
}

Customer Support

Need any assistance? Get in touch with Customer Support.


Updates

Stay up to date by following @apiverveHQ on Twitter.


All usage of the mailboxlayer website, API, and services is subject to the APIVerve Terms of Service and all legal documents and agreements.


License

Licensed under the The MIT License (MIT)

Copyright (©) 2024 APIVerve, and Evlar LLC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net20 is compatible.  net35 is compatible.  net40 is compatible.  net403 was computed.  net45 is compatible.  net451 was computed.  net452 was computed.  net46 was computed.  net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.1.2 110 7/17/2024
1.0.8 102 5/16/2024
1.0.7 89 5/16/2024
1.0.6 97 5/15/2024
1.0.5 104 5/14/2024
1.0.3 102 5/14/2024