Oceanio Search
GET
Search Ocean.io by domain or company name to find the matching company, similar companies, contacts, and people.
Credit cost: 1 credit per call
ApiKeyAuthheader
x-api-key<token>Your API key. Include it in the x-api-key header for every request.
query*stringDomain or company name.
Required. Accepts:
- A domain name (e.g.
google.com,stripe.com) - A company name
Example:
google.comNotes:
- A company name is resolved to a domain first.
companiesis the matched company.resultscontains similar companies ranked by relevance score (0 to 1).peopleis grouped by domain and can includejob_titleandphoto.
fields?stringComma-separated list of response fields to return, with dot notation for nested fields (e.g. name,location.city).
is_async?booleanRun the request as a background job: the API answers 202 with a job_id to poll on GET /v1/jobs/{id}.
Default
falsesoft_fail?booleanReturn HTTP 200 even when the request fails; the error is in the error field of the body.
Default
falseSuccessful response
application/json- response
total?integerpeople?results?array<>companies?array<>curl -X GET 'https://api.piloterr.com/v2/oceanio/search?query=string'Example Response
{ "total": 17286, "people": { "google.com": [ { "id": "aadeeshgarg", "photo": "https://images.aviato.co/entity-images/person?id=fTAjrx0423cxW2eaUfbHYo8xx9PcxoI", "job_title": "Software Engineer", "last_name": "Garg", "first_name": "Aadeesh" } ] }, "results": [ { "url": "http://www.baidu.com/baidu.html?from=noscript", "logo": "https://cdn.ocean.io/logos/baidu.com/82b9ece05c9d92c810fabbc84a208c16a1cfad5d.png", "name": "Baidu", "score": 1, "domain": "baidu.com", "phones": [ { "number": "+86 10 5992 8888", "country": "cn", "primary": true } ], "countries": [ "au", "cn", "gb", "tw", "us" ], "locations": [ { "region": "Beijing", "country": "cn", "locality": "Beijing" } ], "industries": [ "Software Engineering" ], "description": "Most of Baidu's revenue comes from Baidu core, with the rest coming from video-streaming subsidiary iQiyi. The firm's main businesses include online marketing services from its search engine, AI cloud infrastructure, AI applications, AI marketing, and autonomous driving.", "company_size": "I", "people_count": 18178, "year_founded": 2000, "website_status": 13 }, { "url": "https://yandex.com", "logo": "https://cdn.ocean.io/logos/yandex.com/23288ad569a8afc502172adfec84075aa76e3d91.png", "name": "Yandex", "score": 1, "domain": "yandex.com", "phones": [ { "number": "+7 495 739-70-00", "country": "ru", "primary": true } ], "locations": [ { "country": "ru", "locality": "Moscow", "postal_code": "119021", "street_address": "16, Leo Tolstoy St" } ], "description": "Yandex International PJSC is a technology company that provides intelligent products and services managed by machine learning.", "company_size": "I", "people_count": 16802, "year_founded": 1997, "website_status": 1 } ], "companies": [ { "url": "https://www.google.com", "logo": "https://cdn.ocean.io/logos/google.com/a9f28f00b14b94419d51c0c9c5ed9ba53dfdf235.png", "name": "Google", "domain": "google.com", "locations": [ { "region": "CA", "country": "us", "locality": "Mountain View", "postal_code": "94043", "street_address": "1600 Amphitheatre Parkway" } ], "industries": [ "Software Engineering" ], "description": "Google provides internet products and services, including online search, advertising, YouTube, Android and Google Cloud.", "company_size": "I", "people_count": 426322, "year_founded": 1996, "website_status": 1, "social_networks": [ { "url": "https://www.linkedin.com/company/google", "platform": "linkedin" }, { "url": "https://twitter.com/google", "platform": "x" } ] } ]}