BlockSpaces User Documentation
  • 📝Release Notes & Schedule
  • Products
    • 💻BlockSpaces App Onboarding
  • 💱ARC : Auto-Reconciled Collateral
    • ARC Concepts
    • Setting Up Your ARC Account
    • Using the ARC Dashboard
      • Contract Management
      • Banking Instructions - Coming soon
      • Settings
    • Using the API's
      • As a single counterparty
      • As an authorized custodian
  • 🔡API
    • Authentication and Authorization API
    • Contract Management API
    • Webhook/Subscription Management API
    • Fiat Transactions
Powered by GitBook
On this page
  • Authentication
  • Common request format
  • Common Response Format
  • Components of the API

API

The API is broken into different components

PreviousAs an authorized custodianNextAuthentication and Authorization API

Last updated 10 months ago

Authentication

To use the API, you need to receive an API Key. Contact BlockSpaces Support, support@blockspaces.com, to receive your API Key.

The API Key is always passed in as an http header variable, X-API-KEY.

API Keys are valid for 12 months.

Common request format

baseUrl: https://app.blockspaces.com
headers: { 'Content-Type': 'application/json', 'X-API-KEY': 'your api key' }

Common Response Format

All API calls respond with the following format.

{
    "status": "success" | "failure",
    "data": JSON response format is described on each API document page,
    "message": "informational message"
}

Components of the API

🔡

Authentication and Authorization

Contract Management

Subscription Management