FLOOKUP API DOCUMENTATION

BUY CREDITS ONCE, USE THEM FOREVER. NO SUBSCRIPTIONS. NO EXPIRY.

API Pro
$29
  • Each purchase adds to your existing credit balance
  • Pay-as-you-go credits: 5000 calls
  • Rate limit: 20 requests/minute
  • Maximum dataset size: 1000 rows
  • Processing timeout: 15-45 seconds
Buy API Pro
API Master
$79
  • Each purchase adds to your existing credit balance
  • Pay-as-you-go credits: 25000 calls
  • Rate limit: 60 requests/minute
  • Maximum dataset size: 5000 rows
  • Processing timeout: 30-90 seconds
Buy API Master

Introduction to the Flookup API

Flookup API provides automated data cleaning, fuzzy matching and deduplication for your internal systems or public facing workflows. Commercial use is permitted, but redistribution or resale is not. Key features include:

How to Get Started with the API

  1. Click the relevant button above to activate a plan of your choice.
  2. Choose any payment method and fill in the details as prompted.
  3. Open the confirmation email after payment to get copy your "Profile ID" and "API key".

Notes on API Usage

Request Authentication

All API requests must be authenticated. You need to include your "apiKey" and "profileId" in the JSON body of every request. You will receive these credentials when you subscribe to an API plan.

Example Request Body Structure: 

{
  "apiKey": "your_api_key_here",
  "profileId": "your_profile_id_here",
  ...
}

Failure to provide valid credentials will result in an authentication error.

Subscription Authentication

To use the Flookup API, you will need an API key, which is included with your API Pro or API Master subscription. This key authenticates your requests and tracks your usage. Ensure you keep your API key confidential and secure. For detailed instructions on obtaining and managing your API key, refer to the subscription upgrade stub above.

How to Make API Requests

You can test the Flookup API directly from your terminal using cURL. Below is an example of how to call the /fuzzyLookup endpoint with a JSON payload: 

curl -X POST https://fuzzylookup.getflookup.com \
  -H "Content-Type: application/json" \
  -d '{
    "apiKey": "your_api_key_here",
    "profileId": "USER-12345",
    "lookup_value": [["apple"]],
    "table_array": [["apple","fruit"],["banana","fruit"]],
    "lookup_col": 1,
    "index_num": 2
  }'

Or in Google Apps Script:

function callFlookup() {
  let url = "https://fuzzylookup.getflookup.com";
  let payload = {
    apiKey: "your_api_key_here",
    profileId: "USER-12345",
    lookup_value: [["apple"]],
    table_array: [["apple","fruit"], ["banana","fruit"]],
    lookup_col: 1,
    index_num: 2
  };
  let options = {
    method: "POST",
    contentType: "application/json",
    payload: JSON.stringify(payload),
    muteHttpExceptions: true
  };
  let response = UrlFetchApp.fetch(url, options);
  let responseCode = response.getResponseCode();
  let responseBody = response.getContentText();
  if (responseCode === 200) {
    let data = JSON.parse(responseBody);
    Logger.log(data.result);
  } else {
    Logger.log(`Error: ${responseCode} - ${responseBody}`);
  }
}

Flookup API Endpoints

Fuzzy Lookup

POST https://fuzzylookup.getflookup.com
{
  "apiKey": "your_api_key_here",
  "profileId": "USER-12345",
  "lookup_value": [["search term"]],
  "table_array": [["row1col1", "row1col2"], ["row2col1", "row2col2"]],
  "lookup_col": 1,
  "index_num": 2,
  "threshold": 0.8
}

Parameters Explained

Response

{
  "result": [["matched value", score], ...]
}

Errors

{
  "error": "!ERROR: ..."
}

Fuzzy Similarity

POST https://fuzzysimilarity.getflookup.com
{
  "apiKey": "your_api_key_here",
  "profileId": "USER-12345",
  "left_string": "string1",
  "right_string": "string2"
}

Parameters Explained

Response

{
  "result": 0.92
}

Errors

{
  "error": "!ERROR: ..."
}

Unique List

POST https://uniquelist.getflookup.com
{
  "apiKey": "your_api_key_here",
  "profileId": "USER-12345",
  "col_array": [["value1"], ["value2"], ...],
  "index_num": 1,
  "threshold": 0.8,
  "operation": "by_percentage"
}

Parameters Explained

Response

{
  "result": [["unique1"], ["unique2"], ...]
}

Errors

{
  "error": "!ERROR: ..."
}

Check Quota Status

POST https://checkquotastatus.getflookup.com
{
  "apiKey": "your_api_key_here",
  "profileId": "USER-12345"
}

Parameters Explained

Response

{
  "plan": "API Pro",
  "usage": 1250,
  "quota": 5000,
  "remaining": 3750,
  "percentage_used": 25,
  "status": "active"
}

Errors

{
  "error": "!ERROR: ..."
}

Flookup API Privacy

We are committed to protecting your privacy. When you use the Flookup API, we collect your API key and profile ID for authentication and usage tracking. We do not store the data you process through the API. All data transmission is encrypted. For more details, please see our full Privacy Policy.

Explore More