# Makeup API

> Search a free catalogue of about 930 makeup products from some 60 brands, including Maybelline, NYX, Clinique and ColourPop, by type, tags such as Vegan or Gluten free, price and rating, with each product's shades, photos and a link to buy it. The catalogue was gathered in 2016-2018 and is not updated. No account or API key required.

App · 2 actions. Web page: https://docs.lodol.com/docs/integrations/makeup-api

## Actions

### Get product

Get one makeup product by its Makeup API id: its name, brand, type, price, rating, tags, description, photos, link to buy it and every shade it comes in. No API key required.

**Inputs**

- Product ID (`product_id`, number, required): The product's Makeup API id, e.g. 1047. Search products returns it as 'id'. At least 1.

**Outputs**

- `brand` (text): The brand, e.g. 'ColourPop' or 'Maybelline'.
- `category` (text): A finer grouping within the type, e.g. 'lip_gloss' or 'palette'. Empty for many products.
- `color_count` (number): How many shades the product comes in.
- `colors` (list): Every shade the product comes in.
- `created_at` (text): When the product was added to the Makeup API (ISO 8601).
- `currency` (text): The price's currency code, e.g. 'USD' or 'CAD', when known.
- `description` (text): The retailer's product description, as plain text.
- `featured_image_url` (text): A link to the Makeup API's own copy of the product photo.
- `id` (number): The Makeup API's id for the product; use it with Get product.
- `image_url` (text): A link to the product photo on the retailer's site.
- `name` (text): The product's name, e.g. 'Blotted Lip'.
- `price` (number): The price the retailer listed, e.g. 5.5. Some products show 0 where no price was listed.
- `price_sign` (text): The currency symbol, e.g. '$' or '£', when known.
- `product_type` (text): The kind of product: blush, bronzer, eyebrow, eyeliner, eyeshadow, foundation, lip_liner, lipstick, mascara or nail_polish.
- `product_url` (text): The product's page on the retailer's site.
- `rating` (number): The average customer rating out of 5, when there is one.
- `retailer_url` (text): The retailer's or brand's website, e.g. 'https://colourpop.com'.
- `tags` (list): Labels such as 'Vegan', 'Gluten Free' or 'cruelty free'.
- `updated_at` (text): When the product was last updated in the Makeup API (ISO 8601).

**Example output**

```json
{
  "brand": "ColourPop",
  "category": "lipstick",
  "color_count": 7,
  "colors": [
    {
      "hex": "#B72227",
      "name": "Bee's Knees"
    },
    {
      "hex": "#BB656B",
      "name": "Brain Freeze"
    },
    {
      "hex": "#8E4140",
      "name": "Drip"
    },
    {
      "hex": "#A12A33",
      "name": "On a Stick"
    },
    {
      "hex": "#904550",
      "name": "Ice Cube"
    },
    {
      "hex": "#452222",
      "name": "Lolly"
    },
    {
      "hex": "#7C3F35",
      "name": "Candyfloss"
    }
  ],
  "created_at": "2018-07-08T22:01:20.178Z",
  "currency": "CAD",
  "description": "Blotted Lip Sheer matte lipstick that creates the perfect popsicle pout! Formula is lightweight, matte and buildable for light to medium coverage.",
  "featured_image_url": "https://s3.amazonaws.com/donovanbailey/products/api_featured_images/000/001/047/original/open-uri20180708-4-e7idod?1531087336",
  "id": 1047,
  "image_url": "https://cdn.shopify.com/s/files/1/1338/0845/products/brain-freeze_a_800x1200.jpg?v=1502255076",
  "name": "Blotted Lip",
  "price": 5.5,
  "price_sign": "$",
  "product_type": "lipstick",
  "product_url": "https://colourpop.com/collections/lippie-stix?filter=blotted-lip",
  "rating": null,
  "retailer_url": "https://colourpop.com",
  "tags": [
    "cruelty free",
    "Vegan"
  ],
  "updated_at": "2018-07-09T00:53:23.287Z"
}
```

### Search products

Find makeup products by brand, product type, category, tags (such as Vegan or Gluten free), price and rating. Each product comes with its price, rating, shades, description, photo and a link to buy it. Every filter is optional and they all apply together. No API key required.

**Inputs**

- Brand (`brand`, text): Only products from this brand. Leave empty for every brand. One of: `almay`, `alva`, `anna sui`, `annabelle`, `benefit`, `boosh`, `burt's bees`, `butter london`, `c'est moi`, `cargo cosmetics`, and 47 more.
- Product type (`product_type`, text): Only this kind of product. Leave empty for every kind. One of: `blush`, `bronzer`, `eyebrow`, `eyeliner`, `eyeshadow`, `foundation`, `lip_liner` (Lip liner), `lipstick`, `mascara`, `nail_polish` (Nail polish).
- Category (`product_category`, text): Only products in this category, such as Lip gloss or Palette. Many products have no category, so this narrows a lot. One of: `bb_cc` (BB & CC cream), `concealer`, `contour`, `cream`, `gel`, `highlighter`, `lip_gloss` (Lip gloss), `lip_stain` (Lip stain), `lipstick`, `liquid`, and 4 more.
- Tags (`product_tags`, list): Only products carrying every one of these tags, such as Vegan and Gluten free. One or more of: `alcohol free`, `canadian`, `certclean`, `chemical free`, `cruelty free`, `dairy free`, `ecocert`, `ewg verified`, `fair trade`, `gluten free`, and 13 more.
- Price above (`price_greater_than`, number): Only products that cost more than this. Prices are in the currency the retailer listed (often US or Canadian dollars), and the comparison is strict. At least 0.
- Price below (`price_less_than`, number): Only products that cost less than this. Prices are in the currency the retailer listed (often US or Canadian dollars), and the comparison is strict. At least 0.
- Rating above (`rating_greater_than`, number): Only products rated higher than this, out of 5. Unrated products are left out. From 0 to 5.0.
- Rating below (`rating_less_than`, number): Only products rated lower than this, out of 5. Unrated products are left out. From 0 to 5.0.
- Number of results (`limit`, number): How many products to return, 1 to 100. Defaults to 20. From 1 to 100. Default: `20`.

**Outputs**

- `count` (number): How many products are in this list.
- `has_more` (true/false): True when more products matched than were returned; raise the number of results or narrow the filters to see them.
- `products` (list): The matching products, up to the number of results asked for.
- `total_matched` (number): How many products matched the filters in all.

**Example output**

```json
{
  "count": 1,
  "has_more": true,
  "products": [
    {
      "brand": "ColourPop",
      "category": "lipstick",
      "color_count": 7,
      "colors": [
        {
          "hex": "#B72227",
          "name": "Bee's Knees"
        },
        {
          "hex": "#BB656B",
          "name": "Brain Freeze"
        },
        {
          "hex": "#8E4140",
          "name": "Drip"
        },
        {
          "hex": "#A12A33",
          "name": "On a Stick"
        },
        {
          "hex": "#904550",
          "name": "Ice Cube"
        },
        {
          "hex": "#452222",
          "name": "Lolly"
        },
        {
          "hex": "#7C3F35",
          "name": "Candyfloss"
        }
      ],
      "created_at": "2018-07-08T22:01:20.178Z",
      "currency": "CAD",
      "description": "Blotted Lip Sheer matte lipstick that creates the perfect popsicle pout! Formula is lightweight, matte and buildable for light to medium coverage.",
      "featured_image_url": "https://s3.amazonaws.com/donovanbailey/products/api_featured_images/000/001/047/original/open-uri20180708-4-e7idod?1531087336",
      "id": 1047,
      "image_url": "https://cdn.shopify.com/s/files/1/1338/0845/products/brain-freeze_a_800x1200.jpg?v=1502255076",
      "name": "Blotted Lip",
      "price": 5.5,
      "price_sign": "$",
      "product_type": "lipstick",
      "product_url": "https://colourpop.com/collections/lippie-stix?filter=blotted-lip",
      "rating": null,
      "retailer_url": "https://colourpop.com",
      "tags": [
        "cruelty free",
        "Vegan"
      ],
      "updated_at": "2018-07-09T00:53:23.287Z"
    }
  ],
  "total_matched": 2
}
```