Skip to main content

A Python library for interacting with Blockpipe Endpoint API

Project description

Blockpipe Client for Python

Blockpipe Client is a Python library for interacting with Blockpipe Endpoint API. It provides a simple interface for fetching data from the API and supports both single endpoint and multiple endpoints.

Installation

Install the package using pip:

pip install blockpipe-client

Usage

  1. Import BlockpipeClient and create a new instance:
from blockpipe_client import BlockpipeClient

client = BlockpipeClient("<PROJECT_SLUG>", {
    "environment": "production",  # optional
    "baseUrl": "https://app.blockpipe.io/endpoint"  # optional
})
  1. Fetch data from the Blockpipe Endpoint API:
results = client.get(["/path1", "/path2"])

or with a single endpoint

result = client.get("/path1")
  1. Use the fetched data in your application:
for result in results:
    print(result)

# If you only requested one endpoint, you can access the data directly:
print(result)

API

BlockpipeClient

A Python class representing a Blockpipe Client instance.

Constructor:

  • project: The project slug.
  • options (optional): A dictionary with optional configurations:
    • environment: The deployment environment. Default is "production".
    • baseUrl: The base URL for the API. Default is "https://app.blockpipe.io/endpoint".

get

A method to fetch data from one or multiple Blockpipe Endpoint API paths.

Arguments:

  • endpoints: A list of endpoint paths or a single endpoint path as a string.

Returns:

A list of data fetched from the specified endpoints, or a single data object if a single endpoint path was provided.

License

Apache 2.0

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

blockpipe-client-0.1.3.tar.gz (6.3 kB view details)

Uploaded Source

Built Distribution

blockpipe_client-0.1.3-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

Details for the file blockpipe-client-0.1.3.tar.gz.

File metadata

  • Download URL: blockpipe-client-0.1.3.tar.gz
  • Upload date:
  • Size: 6.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.6

File hashes

Hashes for blockpipe-client-0.1.3.tar.gz
Algorithm Hash digest
SHA256 01205353c62ae7312c2fc43dede1d23bb736e85f39e98d7e508f3486fa998aff
MD5 9305f3f1629ad215834915299e81e134
BLAKE2b-256 07d3dd2b84187a4e9aff34e58626df9b6db74f4e4a5932baa864224e1416f919

See more details on using hashes here.

File details

Details for the file blockpipe_client-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for blockpipe_client-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 cbd103aa785ca4a56fa7c7c601ccefbe6150be8481010b39be7025b418cd11db
MD5 40caa9304c60d21f5549ec580c06f7db
BLAKE2b-256 a75626526c806bec37ca4fc7b111ddd4709eee55f038a1868b0df5c6044c7f1c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page