Trending Keywords
The main endpoint for the API is https://news.voku.xyz/api/search/
The supporter-only live websocket API endpoint is wss://news.voku.xyz/socket/
To view the documentation for the live websocket API visit the Support page.
Sending a request to the API without any query parameters will result in the last 25 articles being returned.
Query Parameters
| Parameter | Description |
|---|---|
| query | A query string. Is matched against the headline and body of the article. Fuzzy search is implemented. |
| ticker | Matches the ticker against the keywords array and the entities object. |
| page | Default page is 1. Returns the next 25 articles from the index. |
Return Parameters
The API returns a JSON object. The results key is an array of result objects, all which have the following keys:
| Parameter | Description |
|---|---|
| aid | The articles ID. A uuid4 string. |
| timestamp | The date and time the article was posted. |
| headline | The headline for the article. |
| body | The full body of the article. |
| Summary | A short, few sentence summary of the body of the article. |
| keywords | The top 5 most important keywords extracted from the body of the article. |
| entities | An object of the 10 most relevant extracted entities along with a NER code:
|