Quickstart

Set-up Blochouse

To use the Blockhouse SDK, you need to authenticate using an API key. Each API key is a 32-character string, that can be found from API keys page on your portal. The authentication process ensures secure access to the Blockhouse services and protects your data.

Step 1: Create a Blockhouse Account

To generate an API key, you must first create an account on the Blockhouse platform:

Visit Blockhouse.
Click on Sign Up and provide the required details.
Verify your email and log in to your account.

Step 2: Generate an API Key

Once you have an account, follow these steps to generate an API key:

Navigate to the API Keys section in your Blockhouse dashboard.
Click on Create New API Key.
Copy and securely store the API key as it will be required to authenticate requests.

Step 3: Authenticate API Requests

To use the SDK, you need to provide the API key in your application. The API key can be set as an environment variable or passed explicitly in your script:

Option 1: Using an Environment Variable

Set the API key in your system environment variables:

export BLOCKHOUSE_API_KEY='your_api_key_here'

On Windows (PowerShell):

$env:BLOCKHOUSE_API_KEY="your_api_key_here"

Option 2: Passing API Key in the Code

You can also pass the API key directly when initializing the SDK:

from blockhouse import Client

api_key = "your_api_key_here"
client = Client(api_key)

Best Practices for API Key Security

Never share your API key publicly or hard-code it in source code.
Use environment variables or secure storage solutions.
Rotate API keys periodically to enhance security.

Choose a service

Blockhouse offers two data services: historical and live. While these services are largely similar, they are separated due to licensing costs and differences between request-response and real-time streaming APIs. You have the flexibility to integrate either one or both services.

Historical

Live

Coverage

coming soon..

Pricing

coming soon..

Access

Client libraries (C++, Python, and Rust) and API (HTTP).

coming soon..

Uncover your first set of trading insights

Install SDK

bash

pip install blockhouse==1.0.21

Authenticate & Send

python

from blockhouse import Transfer

client = Transfer(api_key="your_api_key") 

result = client.process_data(
    #market_data_path='file.csv',#optional
    trade_data_path='file1.csv',#Mandatory
    bucket_name="blockhouse-sdk",
    risk_factor=0.5,
    time_horizon=5,
)
print(result)

View SDK Documentation →

Next steps

You have successfully integrated the Blockhouse SDK! Here’s what you can do next:

PreviousHome NextTutorial Videos

Last updated 4 days ago

from blockhouse import Transfer client = Transfer(api_key="your_api_key") result = client.process_data( #market_data_path='file.csv',#optional trade_data_path='file1.csv',#Mandatory bucket_name="blockhouse-sdk", risk_factor=0.5, time_horizon=5, ) print(result)