API Reference

This document provides API reference for interacting with Built By DAO smart contracts and off-chain services.

🔌 API Overview

⛓️ On-Chain

🌐 Off-Chain

📊 Indexer

🔗 Integrations

Contract ABIs

REST API

Subgraph

SDKs

🎯 Purpose: Enable developers to build on Built By DAO infrastructure

📚 Coverage: Contract interfaces, events, and external APIs

⛓️ Contract Interfaces

Token Contracts

BLTBYToken (ERC-20)

// Core Functions
function mint(address to, uint256 amount) external;
function burn(uint256 amount) external;
function transfer(address to, uint256 amount) external returns (bool);

// View Functions
function balanceOf(address account) external view returns (uint256);
function totalSupply() external view returns (uint256);
function allowance(address owner, address spender) external view returns (uint256);

EQTBLTToken (Modified ERC-20)

// Minting (restricted)
function mint(address to, uint256 amount) external;
function burnFrom(address account, uint256 amount) external;

// View Functions
function balanceOf(address account) external view returns (uint256);
function totalSupply() external view returns (uint256);

// Note: transfer() is disabled (soul-bound)

NFT Contracts

MembershipNFT

// Minting
function mintMember(address to, uint8 tokenId) external;
function promoteToMember(address candidate, address promoter) external;

// View Functions
function ownerOf(uint256 tokenId) external view returns (address);
function tokenIdOf(address owner) external view returns (uint256);
function getRank(address member) external view returns (uint8);

Financial Contracts

Treasury

// Withdrawals (governance)
function withdraw(address token, address to, uint256 amount) external;

// View Functions
function getBalance(address token) external view returns (uint256);
function totalBalanceUsd() external view returns (uint256);
function getSpendingLimits() external view returns (uint256, uint256, uint256);

BLTBYBank

// Trading
function buyBLTBY(address stablecoin, uint256 amount) external;
function sellBLTBY(address stablecoin, uint256 amount) external;

// View Functions
function getBuyPrice() external view returns (uint256);
function getSellPrice() external view returns (uint256);
function getAvailableLiquidity() external view returns (uint256);

📡 Contract Events

Token Events

// BLTBY / EQTBLT
event Transfer(address indexed from, address indexed to, uint256 value);
event Approval(address indexed owner, address indexed spender, uint256 value);
event Mint(address indexed to, uint256 amount);
event Burn(address indexed from, uint256 amount);

NFT Events

// MembershipNFT
event MemberMinted(address indexed member, uint8 tokenId);
event RankUpdated(address indexed member, uint8 oldRank, uint8 newRank);
event MemberBurned(address indexed member, uint8 tokenId);

Governance Events

event ProposalCreated(
    uint256 indexed proposalId,
    address proposer,
    address[] targets,
    uint256[] values,
    bytes[] calldatas,
    string description
);

event VoteCast(
    address indexed voter,
    uint256 indexed proposalId,
    uint8 support,
    uint256 weight,
    string reason
);

event ProposalExecuted(uint256 indexed proposalId);
event ProposalCanceled(uint256 indexed proposalId);

Financial Events

// Treasury
event Deposit(address indexed token, address indexed from, uint256 amount);
event Withdrawal(address indexed token, address indexed to, uint256 amount);

// Bank
event BLTBYPurchased(address indexed buyer, uint256 amount, uint256 price);
event BLTBYSold(address indexed seller, uint256 amount, uint256 price);

// Rental
event RentPaid(address indexed tenant, uint256 amount, uint256 eqtbltMinted);

Listening to Events

// ethers.js example
const filter = treasury.filters.Withdrawal();
treasury.on(filter, (token, to, amount, event) => {
    console.log(`Withdrawal: ${amount} to ${to}`);
});

🌐 Off-Chain API

Base URL

https://api.builtbydao.com/v1

Authentication

# API Key in header
Authorization: Bearer YOUR_API_KEY

Endpoints

Members

GET /members
GET /members/:address
GET /members/:address/activity
GET /members/:address/tasks

Tasks

GET /tasks
GET /tasks/:id
POST /tasks/:id/claim
POST /tasks/:id/submit

Governance

GET /proposals
GET /proposals/:id
GET /proposals/:id/votes

Example Requests

# Get member info
curl -X GET "https://api.builtbydao.com/v1/members/0x..." \
    -H "Authorization: Bearer $API_KEY"

# Get active tasks
curl -X GET "https://api.builtbydao.com/v1/tasks?status=open" \
    -H "Authorization: Bearer $API_KEY"

Response Format

{
    "success": true,
    "data": {
        "address": "0x...",
        "rank": 40,
        "eqtblt": "5000",
        "joinedAt": "2024-01-15T10:30:00Z"
    },
    "meta": {
        "timestamp": "2024-06-15T14:22:00Z"
    }
}

📊 Graph Protocol

Subgraph URL

https://api.thegraph.com/subgraphs/name/builtbydao/main

Example Queries

Get Member

query GetMember($address: String!) {
    member(id: $address) {
        id
        tokenId
        rank
        eqtbltBalance
        joinedAt
        tasks {
            id
            status
            eqtbltReward
        }
    }
}

Get Proposals

query GetProposals($first: Int!, $skip: Int!) {
    proposals(
        first: $first
        skip: $skip
        orderBy: createdAt
        orderDirection: desc
    ) {
        id
        proposer
        description
        status
        forVotes
        againstVotes
        abstainVotes
        createdAt
        executedAt
    }
}

Get Treasury Flows

query GetTreasuryFlows($from: BigInt!, $to: BigInt!) {
    deposits(where: { timestamp_gte: $from, timestamp_lte: $to }) {
        id
        token
        amount
        timestamp
    }
    withdrawals(where: { timestamp_gte: $from, timestamp_lte: $to }) {
        id
        token
        amount
        recipient
        timestamp
    }
}

Schema

type Member @entity {
    id: ID!
    tokenId: BigInt!
    rank: Int!
    eqtbltBalance: BigInt!
    bltbyBalance: BigInt!
    tasks: [Task!]! @derivedFrom(field: "assignee")
    votes: [Vote!]! @derivedFrom(field: "voter")
    joinedAt: BigInt!
}

type Proposal @entity {
    id: ID!
    proposer: Member!
    description: String!
    status: ProposalStatus!
    forVotes: BigInt!
    againstVotes: BigInt!
    votes: [Vote!]! @derivedFrom(field: "proposal")
    createdAt: BigInt!
}

🔧 SDK Integration

JavaScript/TypeScript

npm install @builtbydao/sdk

import { BuiltByDAO } from '@builtbydao/sdk';

const dao = new BuiltByDAO({
    rpcUrl: 'https://mainnet.base.org',
    apiKey: process.env.API_KEY
});

// Get member info
const member = await dao.members.get('0x...');

// Get voting power
const power = await dao.governance.getVotingPower('0x...');

// Submit vote
await dao.governance.vote(proposalId, 1, signer);

Python

pip install builtbydao

from builtbydao import BuiltByDAO

dao = BuiltByDAO(
    rpc_url='https://mainnet.base.org',
    api_key=os.environ['API_KEY']
)

# Get member info
member = dao.members.get('0x...')

# Get proposals
proposals = dao.governance.get_proposals(status='active')

Contract Interaction

import { ethers } from 'ethers';
import { BLTBY_ABI, ADDRESSES } from '@builtbydao/sdk';

const provider = new ethers.JsonRpcProvider(RPC_URL);
const bltby = new ethers.Contract(
    ADDRESSES.BLTBY,
    BLTBY_ABI,
    provider
);

const balance = await bltby.balanceOf(address);

Wallet Integration

// Connect wallet
const signer = await dao.connect(window.ethereum);

// Sign and send transaction
const tx = await dao.bank.buyBLTBY(
    amount,
    'USDC',
    signer
);

await tx.wait();

📋 Rate Limits & Usage

API Limits

Tier

Requests/Min

Requests/Day

🆓 Free

10,000

📊 Basic

300

100,000

🚀 Pro

1,000

Unlimited

Response Headers

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 45
X-RateLimit-Reset: 1623456789

Error Responses

Code

Meaning

400

Bad request

401

Unauthorized

403

Forbidden

404

Not found

429

Rate limited

500

Server error

{
    "success": false,
    "error": {
        "code": "RATE_LIMITED",
        "message": "Too many requests. Please try again later."
    }
}

Best Practices

Practice

Recommendation

🔄 Caching

Cache responses locally

📊 Batching

Combine requests

⏱️ Backoff

Exponential retry

🔍 Webhooks

Use for real-time

📊 Contract Addresses

Contract

Base Mainnet

BLTBYToken

0x...

EQTBLTToken

0x...

MembershipNFT

0x...

Treasury

0x...

Governance

0x...

BLTBYBank

0x...

RentalAndRebate

0x...

🔌 Getting Started

📋 Get API key from dashboard
🔧 Install SDK
⛓️ Connect to Base network
📊 Start building!

💻Overview Smart Contracts Architecture

PreviousDeployment NextAll Guides

Last updated 14 days ago

Good afternoon

hashtag🔌 API Overview

hashtag⛓️ Contract Interfaces

hashtagToken Contracts

hashtagNFT Contracts

hashtagFinancial Contracts

hashtag📡 Contract Events

hashtagToken Events

hashtagNFT Events

hashtagGovernance Events

hashtagFinancial Events

hashtagListening to Events

hashtag🌐 Off-Chain API

hashtagBase URL

hashtagAuthentication

hashtagEndpoints

hashtagExample Requests

hashtagResponse Format

hashtag📊 Graph Protocol

hashtagSubgraph URL

hashtagExample Queries

hashtagSchema

hashtag🔧 SDK Integration

hashtagJavaScript/TypeScript

hashtagPython

hashtagContract Interaction

hashtagWallet Integration

hashtag📋 Rate Limits & Usage

hashtagAPI Limits

hashtagResponse Headers

hashtagError Responses

hashtagBest Practices

hashtag🔌 Getting Started

hashtag🔗 Related Pages

🔌 API Overview

⛓️ Contract Interfaces

Token Contracts

NFT Contracts

Financial Contracts

📡 Contract Events

Token Events

NFT Events

Governance Events

Financial Events

Listening to Events

🌐 Off-Chain API

Base URL

Authentication

Endpoints

Example Requests

Response Format

📊 Graph Protocol

Subgraph URL

Example Queries

Schema

🔧 SDK Integration

JavaScript/TypeScript

Python

Contract Interaction

Wallet Integration

📋 Rate Limits & Usage

API Limits

Response Headers

Error Responses

Best Practices

🔌 Getting Started

🔗 Related Pages