Search

Search Record

POST
Search for a record. Please note, searches are limited to a maximum of 10,000 results.

Query parameters

limitintegerOptional
A limit on the number of objects to be returned with a range between 1 and 100. Defaults to 100.
offsetintegerOptional
Number of results to skip before returning response. Defaults to 0.

Request

This endpoint expects an object.
q
stringRequired
Query term. The syntax for the query parameter follows elasticsearch simple query string syntax. The includes the ability to use search operators and to perform nested queries. Must be url encoded.
fields
list of enumsOptional
Record or entity fields to search against.
filter
objectOptional
Filters to be applied to search query to limit the result-set.
facets
booleanOptional
Whether or not to return search facets in results giving counts by field. Defaults to false.
advanced
booleanOptional
Set to true to enable full elasticsearch query string syntax which allows for fielded search and more complex operators. Note that the syntax is more strict and can result in empty result-sets. Defaults to false.

Response

This endpoint returns an object
data
list of objects
limit
integer
next
boolean
offset
integer
size
object
POST
1curl -X POST "https://api.sayari.com/v1/search/record?limit=1" \
2     -H "Authorization: Bearer <token>" \
3     -H "Content-Type: application/json" \
4     -d '{
5  "q": "victoria beckham limited"
6}'
200
Successful
1{
2  "data": [
3    {
4      "id": "a7e5a83df5551eb557688c84451abd9d/0000950123-09-004358-index.htm/1697610858173",
5      "label": "Company Record from USA SEC 10-K Database",
6      "source": "a7e5a83df5551eb557688c84451abd9d",
7      "acquisition_date": "2023-10-18",
8      "references_count": 10,
9      "record_url": "/v1/record/a7e5a83df5551eb557688c84451abd9d%2F0000950123-09-004358-index.htm%2F1697610858173",
10      "publication_date": "2009-03-10",
11      "source_url": "https://www.sec.gov/Archives/edgar/data/2488/000119312513069422/0000950123-09-004358-index.htm",
12      "matches": {
13        "text": [
14          "In\n    addition, David and <em>Victoria</em> <em>Beckham</em> have agreed to pursue the\n    development and exploitation of projects relating to\n    merchandising, products and skills (that do not, with certain\n    exceptions, include the name “<em>Beckham</em>”) exclusively\n    through a joint venture vehicle, <em>Beckham</em> Brand <em>Limited</em>",
15          "(“BBL”), which is owned one-third by each of David\n    <em>Beckham</em>, <em>Victoria</em> <em>Beckham</em>, and a subsidiary of 19 Entertainment.",
16          "For\n    example, 19 Entertainment manages <em>Victoria</em> <em>Beckham</em>, a fashion\n    and lifestyle personality as well as David <em>Beckham</em>, a globally\n    recognized soccer player who commenced playing for the Los\n    Angeles Galaxy of United States-based Major League Soccer in\n    July 2007 and is currently playing",
17          "<em>Beckham</em> (see\n    below under “<em>Beckham</em> Relationship”), Annie Lennox and\n    Cathy Dennis.",
18          "In 2008, <em>Victoria</em> successfully launched her\n    dress collection, a new denim collection under her DVB Style\n    brand and a DVB line of eyewear."
19        ]
20      },
21      "country": "USA",
22      "page": 8,
23      "page_count": 92
24    }
25  ],
26  "limit": 1,
27  "next": true,
28  "offset": 0,
29  "size": {
30    "count": 182,
31    "qualifier": "eq"
32  }
33}
Built with