Skip to main content
POST
/
api
/
new_york
/
companies
/
search
/new_york/companies/search
curl --request POST \
  --url https://api.anysite.io/api/new_york/companies/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "query": "<string>",
  "count": 2,
  "timeout": 300,
  "search_by": "EntityName",
  "match": "BeginsWith",
  "status": "AllStatuses",
  "entity_types": [
    "Corporation",
    "LimitedLiabilityCompany",
    "LimitedPartnership",
    "LimitedLiabilityPartnership"
  ]
}
'
[
  {
    "dos_id": "<string>",
    "name": "<string>",
    "@type": "@new_york_search_item",
    "company_type": "<string>",
    "entity_status": "<string>",
    "company_type_category": "<string>",
    "name_type": "<string>",
    "assumed_name": "<string>",
    "assumed_name_id": "<string>",
    "non_qualified_id": "<string>",
    "jurisdiction": "<string>",
    "county": "<string>",
    "initial_filing_date": "<string>"
  }
]

Authorizations

​
access-token
string
header
required

API token from the dashboard

Headers

​
access-token
string
required

Body

application/json
​
query
string
required

Search value — entity name or DOS ID

Minimum string length: 1
Example:

"WALMART"

​
count
integer
required

Max number of results to return

Required range: x >= 1
​
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
​
search_by
enum<string>
default:EntityName

Field to search by

Available options:
EntityName,
DOSID,
AssumedName,
AssumedNameID
​
match
enum<string>
default:BeginsWith

Name matching mode

Available options:
BeginsWith,
Contains
​
status
enum<string>
default:AllStatuses

Entity status filter

Available options:
AllStatuses,
Active,
Inactive,
Suspended
​
entity_types
enum<string>[]

Entity types to include in the search

Available options:
Corporation,
LimitedLiabilityCompany,
LimitedPartnership,
LimitedLiabilityPartnership

Response

Successful Response

​
dos_id
string
required
​
name
string
required
​
@type
string
default:@new_york_search_item
​
company_type
string | null
​
entity_status
string | null
​
company_type_category
string | null
​
name_type
string | null
​
assumed_name
string | null
​
assumed_name_id
string | null
​
non_qualified_id
string | null
​
jurisdiction
string | null
​
county
string | null
​
initial_filing_date
string | null