Request Example
Parameter | Description |
---|---|
domain | Specify a domain or set of domains as a base for lookalike matching. Up to 10 domains can be entered. |
negate_domain | A subset of the results that match the negate domain context will be excluded from the match results. This process ensures that only the most relevant domains are considered, removing the need to manually filter out irrelevant domains. The API removes subdomains from the input domain when using negate domain.Up to 10 domains can be entered. |
nl_match | Enter one or more paragraphs of text for our model to use with Natural Language Match. |
negate_nl_match | Provide a detailed description that represents the business concept you wish to exclude. Results that match that concept will be excluded. |
keyword | Specify one or more of search keywords. You can input up to 10 keywords. |
negate_keyword | Specify one or more search keywords to exclude from the results. You can input up to 10 keywords. |
exact_match | Specify the exact text fragment to search. You can input up to 10 text fragments. |
negate_exact_match | Specify the exact text fragment to exclude from the results. Up to 10 text fragments can be entered. |
state | Limit results to a single state by using USA state codes. This filter is not supoported with more than one country. This field is optional; all states are included by default. |
country | Limit results to one or more country using ISO-3166-2 two-letter country codes. This field is optional; by default, all countries are included. |
start_date | Minimum company start date, derived from the date of the first certificate in format YYYY-MM-DD. This field is optional. |
min_score | Set the minimum score to include in the output, within a range of 0-800. This field is optional, with a default value of 50, representing small businesses. |
max_score | Set the maximum score to include in the output, within a range of 0-800. This field is optional, and the default value is set at 800, which includes the largest companies. |
min_similarity | Minimum similarity to include in output, in range 0-99 (optional, defaults to 0) |
max_records | Maximum records to include in the output, in the range 25-1000 (optional, defaults to 100) |
redirect | Set to 1 to include business domains that redirect to another domain. This field is optional and defaults to 0. |
consensus | Using the average of the top-n results from the first pass to refine the source vector in the second pass to significantly enhance the quality of similarity matching. in range 1-20 (optional, defaults to 1) |
page | Select the website page to use for matching. This field is optional and defaults to ‘home’. |
social | Filter results based on the presence of one or more social profiles. This field is optional. Acceptable values are:
|
category | Filter results by the desired industry. A list of acceptable values can be found in the https://app.gitbook.com/o/LOz61XdBjA5J |
language | Filter results by one or more text language using in ISO-639-2 two-letter language codes. This field is optional; by default, all languages are included. |
Last updated