gridbank-api 0.2.0

Official Python SDK for the GridBank API

Python SDK Documentation

Welcome to the GridBank Python SDK documentation. This guide will help you integrate GridBank's video search and download API into your Python application.

Getting Started

1. Installation — Install the SDK with pip
2. Client Setup — Initialize your first client
3. Quick Example — See a working example

Learn by Doing

• Code Examples — Real-world usage patterns and workflows
• Method Reference — Complete API method documentation

Reference

• API Reference — Full REST API specification
• Error Handling — Learn error codes and how to handle them
• Rate Limiting — Understand rate limit behavior

Key Concepts

Authentication

All requests require a Bearer token API key.

from gridbank_api import GridbankClient

client = GridbankClient(api_key="apik_your_key_here")

Core Methods

The SDK provides 4 core methods:

• search_videos() — Search the video library with full-text search
• get_video() — Fetch detailed metadata for a video
• download_video() — Generate signed download URLs
• usage_summary() — Check your subscription tier and quota

Error Handling

All methods raise GridbankAPIError on failures:

from gridbank_api import GridbankAPIError

try:
    results = client.search_videos(q="nature")
except GridbankAPIError as e:
    print(f"Error: {e.code} - {e.message}")

Common Tasks

Search for videos:

results = client.search_videos(q="skincare", per_page=10)

Get video details:

video = client.get_video(video_id="video_abc123")
print(f"{video.title} by {video.creator.name}")

Download a video:

download = client.download_video(video_id="video_abc123")
print(f"Download URL: {download.url}")

Check your usage:

usage = client.usage_summary()
print(f"Tier: {usage.tier}")
print(f"Downloads used: {usage.downloads_this_period}")

Troubleshooting

Installation issues? See Installation Troubleshooting

Error with API key? See Error Codes

Rate limited? See Rate Limiting

Need Help?

• Email: [e-mail]
• API Status
• Full API Reference