Skip to content

Update readme #182

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
oyvindwe merged 2 commits into from
Mar 2, 2026
Merged

Update readme #182

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a2c4fb9
Update readme
Feb 27, 2026
01f3744
Review
Mar 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ A Python SDK which provides easy access to Exabel APIs.
pip install exabel
```

or download from [PyPI](https://pypi.org/project/exabel/).
or download from [PyPI](https://pypi.org/project/exabel).

The SDK requires Python 3.10 or later.

Expand All @@ -32,11 +32,7 @@ Supported data sources are:

## Getting started

To use the SDK against the Data API, Analytics API or Management API, you need an API key provided by Exabel.

The Exabel Export API can be used by authenticating with username and password.
The first time you run the script a web browser window is opened where you are asked to provide username and password. The script stores an access token in ``~/.exabel``, so you will not be asked again
until the token expires.
To use the SDK against, you need an API key or personal access token. This can be found in the Exabel app.

[Export API Developer guide](https://help.exabel.com/docs/exporting-via-exabel-sdk)

Expand Down Expand Up @@ -67,3 +63,10 @@ The Exabel Analytics API can be used to manage derived signals and prediction mo
The Exabel Management API can be used to manage the library on the Exabel Platform.

[Management API Developer guide](https://help.exabel.com/docs/management-api)

## Protocols

For efficiency, the SDK uses gRPC when communicating with the Data API, Analytics API,
and Management API. The Export API is only available as a REST API.

gRPC uses HTTPS on server port 21443, while REST uses HTTPS on server port 443.