Input Parameters - Cleaner APIs
Detailed information on the input parameters used for the Cleaner APIs
Company Cleaner API Parameters (/company/clean
)
/company/clean
)While all parameters are optional, we require a non-ambiguous match. This means that you must input a name
OR website
OR profile
.
name
name
Parameter Name | Required | Description | Example |
---|---|---|---|
| No | The name of the company that you want to identify. Unformatted strings with arbitrary capitalizations, leading and trailing whitespaces, and so forth are accepted. |
|
profile
profile
Parameter Name | Required | Description | Example |
---|---|---|---|
| No | The social profile URL of the company that you want to identify. Unformatted URLs with arbitrary capitalizations, leading and trailing whitespaces, and so forth are accepted. |
|
website
website
Parameter Name | Required | Description | Example |
---|---|---|---|
| No | The website of the company that you want to identify. Unformatted URLs with arbitrary capitalizations, leading and trailing whitespaces, and so forth are accepted. |
|
pretty
pretty
Parameter Name | Required | Description | Example |
---|---|---|---|
| No | Whether the output should have human-readable indentation. |
|
api_key
api_key
Parameter Name | Required | Description | Example |
---|---|---|---|
| No | Not required as part of the request parameters, but if it is not provided here, then it must be provided in the headers using the |
Location Cleaner API (/location/clean
)
/location/clean
)location
location
Parameter Name | Required | Description | Example |
---|---|---|---|
| Yes | The name of the location that you want to identify. Unformatted locations with arbitrary capitalizations, leading and trailing whitespaces, and so forth are accepted. |
|
pretty
pretty
Parameter Name | Required | Description | Example |
---|---|---|---|
| No | Whether the output should have human-readable indentation. |
|
api_key
api_key
Parameter Name | Required | Description | Example |
---|---|---|---|
| No | Not required as part of the request parameters, but if it is not provided here, then it must be provided in the headers using the |
School Cleaner API (/school/clean
)
/school/clean
)While all parameters are optional, we require a non-ambiguous match. This means that you must input a name
OR website
OR profile
.
name
name
Parameter Name | Required | Description | Example |
---|---|---|---|
| No | The name of the company that you want to identify. Unformatted strings with arbitrary capitalizations, leading and trailing whitespaces, and so forth are accepted. |
|
profile
profile
Parameter Name | Required | Description | Example |
---|---|---|---|
| No | The social profile URL of the company that you want to identify. Unformatted URLs with arbitrary capitalizations, leading and trailing whitespaces, and so forth are accepted. |
|
website
website
Parameter Name | Required | Description | Example |
---|---|---|---|
| No | The website of the company that you want to identify. Unformatted URLs with arbitrary capitalizations, leading and trailing whitespaces, and so forth are accepted. |
|
pretty
pretty
Parameter Name | Required | Description | Example |
---|---|---|---|
| No | Whether the output should have human-readable indentation. |
|
api_key
api_key
Parameter Name | Required | Description | Example |
---|---|---|---|
| No | Not required as part of the request parameters, but if not provided here, then it must be provided in the headers using the |
Updated 3 months ago