Entities¶
Entities are the main building blocks of the Everysk SDK. They are the objects that you will interact with to create, read, update, and delete data in the Everysk platform. Every entity inherits its create, retrieve, modify and delete methods from Base Entity, and you search for them with Query.
Authentication
Set your API credentials before you call an entity. See Authentication.
| Group | Entity | Represents | REST API |
|---|---|---|---|
| Basics | Base Entity | The shared methods every entity inherits. | |
| Query | Searching, filtering and paging through entities. | ||
| Tags | The list of tags attached to an entity. | ||
| Data | Portfolio | A collection of securities with a base currency and a date. | Portfolio |
| Security | A single position inside a portfolio. | ||
| Securities | The typed list of securities that holds a portfolio's positions. | ||
| Private Security | A custom fixed income instrument. | Private Security | |
| Custom Index | A proprietary series of date-value pairs. | Custom Index | |
| Datastore | A table of data stored on the platform. | Datastore | |
| File | A file stored on the platform. | File | |
| Automation | Workflow | A workflow you can run. | Workflow |
| Workflow Execution | One run of a workflow. | Workflow Execution | |
| Worker Execution | One run of a worker inside a workflow execution. | Worker Execution | |
| Reports | Report | A dashboard for a portfolio on a given date. | Report |
| Account | Workspace | A workspace that scopes entities. | Workspace |
| Secrets | Credentials and other sensitive values stored on the platform. |