Universal API

The Integra Universal API is the primary public-facing API for accessing workflows, blockchain chains, and transaction data.

Getting Started: You’ll need an API key to access the Universal API. Contact your Integra account manager or visit the Admin API to generate keys.

Interactive API Reference

Quick Start

# List all workflows
curl https://api.integra.dev/v1/workflows \
  -H "Authorization: Bearer YOUR_API_KEY"

// Using fetch
const response = await fetch('https://api.integra.dev/v1/workflows', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});
const data = await response.json();
console.log(data);

import requests
 
response = requests.get(
    'https://api.integra.dev/v1/workflows',
    headers={'Authorization': 'Bearer YOUR_API_KEY'}
)
print(response.json())

package main
 
import (
    "fmt"
    "io"
    "net/http"
)
 
func main() {
    client := &http.Client{}
    req, _ := http.NewRequest("GET", "https://api.integra.dev/v1/workflows", nil)
    req.Header.Add("Authorization", "Bearer YOUR_API_KEY")
 
    resp, _ := client.Do(req)
    defer resp.Body.Close()
 
    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}

Server Environments

Base URL: https://api.integra.dev/v1

Use this for production applications with real data.

Base URL: https://staging-api.integra.dev/v1

Test your integration before going live. Staging data is reset weekly.

Base URL: http://localhost:8787/v1

For local development with the Integra CLI.

Features

💡

Core Capabilities

Workflow Management - List, create, and manage workflows
Chain Registry - Access supported blockchain networks and RPC providers
Transaction Indexing - Query indexed blockchain transactions
Pagination - Efficient data retrieval with cursor-based pagination
Filtering - Advanced filtering on all list endpoints

Rate Limits

⚠️

Rate Limits:

Authenticated requests: 1000 requests/minute
Unauthenticated requests: 60 requests/minute

Exceeding these limits will result in HTTP 429 responses. Implement exponential backoff in your retry logic.

Best Practices

// Always store API keys securely
const apiKey = process.env.INTEGRA_API_KEY;
 
// Include in headers
const headers = {
  'Authorization': `Bearer ${apiKey}`,
  'Content-Type': 'application/json'
};

🚫

Never commit API keys to version control. Use environment variables or secrets management.

async function callAPI(endpoint) {
  try {
    const response = await fetch(endpoint, {
      headers: { 'Authorization': `Bearer ${apiKey}` }
    });
 
    if (!response.ok) {
      throw new Error(`HTTP ${response.status}: ${response.statusText}`);
    }
 
    return await response.json();
  } catch (error) {
    console.error('API Error:', error);
    // Implement retry logic with exponential backoff
  }
}

// Use cursor-based pagination
let cursor = null;
const allResults = [];
 
do {
  const url = cursor
    ? `https://api.integra.dev/v1/workflows?cursor=${cursor}`
    : 'https://api.integra.dev/v1/workflows';
 
  const response = await fetch(url, { headers });
  const data = await response.json();
 
  allResults.push(...data.results);
  cursor = data.next_cursor;
} while (cursor);

API Overview Blockchain API