Create fund

curl --request POST \
  --url https://api.endaoment.org/v1/funds \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fundInput": {
    "name": "Doe Family Foundation",
    "advisor": {
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@example.com",
      "address": {
        "line1": "123 Main Street",
        "city": "San Francisco",
        "line2": "Suite 100",
        "state": "CA",
        "zip": "94105",
        "country": "USA"
      }
    },
    "description": "A family foundation dedicated to supporting educational initiatives",
    "type": "Private"
  },
  "deploymentTransactionHash": "0xf89f7da1e5d79dcb1b8863d0926fe41204785b443ce2d1dca4bf50070c492567",
  "referralSource": "partner_website",
  "fundSalt": "0x7189b9ff31064f2bbc98ad4e92e5562c00000000000000000000000000000000",
  "chainId": 1
}
'

import requests

url = "https://api.endaoment.org/v1/funds"

payload = {
    "fundInput": {
        "name": "Doe Family Foundation",
        "advisor": {
            "firstName": "John",
            "lastName": "Doe",
            "email": "john.doe@example.com",
            "address": {
                "line1": "123 Main Street",
                "city": "San Francisco",
                "line2": "Suite 100",
                "state": "CA",
                "zip": "94105",
                "country": "USA"
            }
        },
        "description": "A family foundation dedicated to supporting educational initiatives",
        "type": "Private"
    },
    "deploymentTransactionHash": "0xf89f7da1e5d79dcb1b8863d0926fe41204785b443ce2d1dca4bf50070c492567",
    "referralSource": "partner_website",
    "fundSalt": "0x7189b9ff31064f2bbc98ad4e92e5562c00000000000000000000000000000000",
    "chainId": 1
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    fundInput: {
      name: 'Doe Family Foundation',
      advisor: {
        firstName: 'John',
        lastName: 'Doe',
        email: 'john.doe@example.com',
        address: {
          line1: '123 Main Street',
          city: 'San Francisco',
          line2: 'Suite 100',
          state: 'CA',
          zip: '94105',
          country: 'USA'
        }
      },
      description: 'A family foundation dedicated to supporting educational initiatives',
      type: 'Private'
    },
    deploymentTransactionHash: '0xf89f7da1e5d79dcb1b8863d0926fe41204785b443ce2d1dca4bf50070c492567',
    referralSource: 'partner_website',
    fundSalt: '0x7189b9ff31064f2bbc98ad4e92e5562c00000000000000000000000000000000',
    chainId: 1
  })
};

fetch('https://api.endaoment.org/v1/funds', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.endaoment.org/v1/funds",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'fundInput' => [
        'name' => 'Doe Family Foundation',
        'advisor' => [
                'firstName' => 'John',
                'lastName' => 'Doe',
                'email' => 'john.doe@example.com',
                'address' => [
                                'line1' => '123 Main Street',
                                'city' => 'San Francisco',
                                'line2' => 'Suite 100',
                                'state' => 'CA',
                                'zip' => '94105',
                                'country' => 'USA'
                ]
        ],
        'description' => 'A family foundation dedicated to supporting educational initiatives',
        'type' => 'Private'
    ],
    'deploymentTransactionHash' => '0xf89f7da1e5d79dcb1b8863d0926fe41204785b443ce2d1dca4bf50070c492567',
    'referralSource' => 'partner_website',
    'fundSalt' => '0x7189b9ff31064f2bbc98ad4e92e5562c00000000000000000000000000000000',
    'chainId' => 1
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.endaoment.org/v1/funds"

	payload := strings.NewReader("{\n  \"fundInput\": {\n    \"name\": \"Doe Family Foundation\",\n    \"advisor\": {\n      \"firstName\": \"John\",\n      \"lastName\": \"Doe\",\n      \"email\": \"john.doe@example.com\",\n      \"address\": {\n        \"line1\": \"123 Main Street\",\n        \"city\": \"San Francisco\",\n        \"line2\": \"Suite 100\",\n        \"state\": \"CA\",\n        \"zip\": \"94105\",\n        \"country\": \"USA\"\n      }\n    },\n    \"description\": \"A family foundation dedicated to supporting educational initiatives\",\n    \"type\": \"Private\"\n  },\n  \"deploymentTransactionHash\": \"0xf89f7da1e5d79dcb1b8863d0926fe41204785b443ce2d1dca4bf50070c492567\",\n  \"referralSource\": \"partner_website\",\n  \"fundSalt\": \"0x7189b9ff31064f2bbc98ad4e92e5562c00000000000000000000000000000000\",\n  \"chainId\": 1\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.endaoment.org/v1/funds")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"fundInput\": {\n    \"name\": \"Doe Family Foundation\",\n    \"advisor\": {\n      \"firstName\": \"John\",\n      \"lastName\": \"Doe\",\n      \"email\": \"john.doe@example.com\",\n      \"address\": {\n        \"line1\": \"123 Main Street\",\n        \"city\": \"San Francisco\",\n        \"line2\": \"Suite 100\",\n        \"state\": \"CA\",\n        \"zip\": \"94105\",\n        \"country\": \"USA\"\n      }\n    },\n    \"description\": \"A family foundation dedicated to supporting educational initiatives\",\n    \"type\": \"Private\"\n  },\n  \"deploymentTransactionHash\": \"0xf89f7da1e5d79dcb1b8863d0926fe41204785b443ce2d1dca4bf50070c492567\",\n  \"referralSource\": \"partner_website\",\n  \"fundSalt\": \"0x7189b9ff31064f2bbc98ad4e92e5562c00000000000000000000000000000000\",\n  \"chainId\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.endaoment.org/v1/funds")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"fundInput\": {\n    \"name\": \"Doe Family Foundation\",\n    \"advisor\": {\n      \"firstName\": \"John\",\n      \"lastName\": \"Doe\",\n      \"email\": \"john.doe@example.com\",\n      \"address\": {\n        \"line1\": \"123 Main Street\",\n        \"city\": \"San Francisco\",\n        \"line2\": \"Suite 100\",\n        \"state\": \"CA\",\n        \"zip\": \"94105\",\n        \"country\": \"USA\"\n      }\n    },\n    \"description\": \"A family foundation dedicated to supporting educational initiatives\",\n    \"type\": \"Private\"\n  },\n  \"deploymentTransactionHash\": \"0xf89f7da1e5d79dcb1b8863d0926fe41204785b443ce2d1dca4bf50070c492567\",\n  \"referralSource\": \"partner_website\",\n  \"fundSalt\": \"0x7189b9ff31064f2bbc98ad4e92e5562c00000000000000000000000000000000\",\n  \"chainId\": 1\n}"

response = http.request(request)
puts response.read_body

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Doe Family Foundation",
  "type": "Private",
  "manager": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "walletAddress": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e"
  },
  "chainId": 1,
  "advisor": {
    "firstName": "John",
    "lastName": "Doe"
  },
  "featuredIndex": 1,
  "usdcBalance": "20500000",
  "availableBalance": "21000000",
  "description": "A family foundation dedicated to supporting educational initiatives",
  "createdAtUtc": "2024-01-01T00:00:00Z",
  "updatedAtUtc": "2024-03-14T12:00:00Z",
  "lifetimeDonationsUsdc": "1000000000",
  "inboundFeeBps": 25,
  "outboundFeeBps": 50,
  "grantsGiven": 10,
  "inTransitBuyUsdcAmount": "5000000",
  "inTransitSellUsdcAmount": "3000000",
  "investedUsdc": "50000000",
  "totalGrantedUsdc": "25000000",
  "processingTransfersTotalUsdc": "1000000",
  "illiquidBalance": "10000000",
  "poolDetails": {
    "eligibleEntities": "Organizations",
    "algorithmType": "QuadraticFunding",
    "distributionSchedule": "Quarterly",
    "distributionPercentage": 0.25,
    "eligibleVotes": "GrantsAndDonations",
    "voteWeight": "UsdcValue"
  },
  "expectedDeploymentInfo": {
    "expectedManagerAddress": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
    "expectedSalt": "0x0000000000000000000000000000000000000000000000000000000000000123",
    "expectedComputedAddress": "0x1234567890123456789012345678901234567890",
    "expectedChainId": 1
  },
  "deploymentTransactionHash": "0xf89f7da1e5d79dcb1b8863d0926fe41204785b443ce2d1dca4bf50070c492567",
  "contractAddress": "0x1234567890123456789012345678901234567890",
  "lastBalanceSyncUtc": "2024-03-14T12:00:00Z",
  "shortDescription": "Supporting education",
  "vanityUrl": "doe-family-foundation",
  "paypalId": "123e4567-e89b-12d3-a456-426614174000",
  "logo": "https://example.com/logo.png",
  "category": "Education",
  "customFeeDetail": "Special Community Fund Agreement",
  "v2ContractAddress": "<string>"
}

{
  "statusCode": 400,
  "message": [
    "fundInput.advisor.firstName must be a non-empty string",
    "fundInput.advisor.lastName must be a non-empty string",
    "fundInput.advisor.email must be an email",
    "fundInput.advisor.address.zip must be shorter than or equal to 255 characters",
    "fundInput.advisor.address.zip must be a string",
    "\"1\" is not a chain id supported by the system"
  ],
  "error": "Bad Request"
}

POST

funds

Create fund

curl --request POST \
  --url https://api.endaoment.org/v1/funds \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fundInput": {
    "name": "Doe Family Foundation",
    "advisor": {
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@example.com",
      "address": {
        "line1": "123 Main Street",
        "city": "San Francisco",
        "line2": "Suite 100",
        "state": "CA",
        "zip": "94105",
        "country": "USA"
      }
    },
    "description": "A family foundation dedicated to supporting educational initiatives",
    "type": "Private"
  },
  "deploymentTransactionHash": "0xf89f7da1e5d79dcb1b8863d0926fe41204785b443ce2d1dca4bf50070c492567",
  "referralSource": "partner_website",
  "fundSalt": "0x7189b9ff31064f2bbc98ad4e92e5562c00000000000000000000000000000000",
  "chainId": 1
}
'

import requests

url = "https://api.endaoment.org/v1/funds"

payload = {
    "fundInput": {
        "name": "Doe Family Foundation",
        "advisor": {
            "firstName": "John",
            "lastName": "Doe",
            "email": "john.doe@example.com",
            "address": {
                "line1": "123 Main Street",
                "city": "San Francisco",
                "line2": "Suite 100",
                "state": "CA",
                "zip": "94105",
                "country": "USA"
            }
        },
        "description": "A family foundation dedicated to supporting educational initiatives",
        "type": "Private"
    },
    "deploymentTransactionHash": "0xf89f7da1e5d79dcb1b8863d0926fe41204785b443ce2d1dca4bf50070c492567",
    "referralSource": "partner_website",
    "fundSalt": "0x7189b9ff31064f2bbc98ad4e92e5562c00000000000000000000000000000000",
    "chainId": 1
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    fundInput: {
      name: 'Doe Family Foundation',
      advisor: {
        firstName: 'John',
        lastName: 'Doe',
        email: 'john.doe@example.com',
        address: {
          line1: '123 Main Street',
          city: 'San Francisco',
          line2: 'Suite 100',
          state: 'CA',
          zip: '94105',
          country: 'USA'
        }
      },
      description: 'A family foundation dedicated to supporting educational initiatives',
      type: 'Private'
    },
    deploymentTransactionHash: '0xf89f7da1e5d79dcb1b8863d0926fe41204785b443ce2d1dca4bf50070c492567',
    referralSource: 'partner_website',
    fundSalt: '0x7189b9ff31064f2bbc98ad4e92e5562c00000000000000000000000000000000',
    chainId: 1
  })
};

fetch('https://api.endaoment.org/v1/funds', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.endaoment.org/v1/funds",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'fundInput' => [
        'name' => 'Doe Family Foundation',
        'advisor' => [
                'firstName' => 'John',
                'lastName' => 'Doe',
                'email' => 'john.doe@example.com',
                'address' => [
                                'line1' => '123 Main Street',
                                'city' => 'San Francisco',
                                'line2' => 'Suite 100',
                                'state' => 'CA',
                                'zip' => '94105',
                                'country' => 'USA'
                ]
        ],
        'description' => 'A family foundation dedicated to supporting educational initiatives',
        'type' => 'Private'
    ],
    'deploymentTransactionHash' => '0xf89f7da1e5d79dcb1b8863d0926fe41204785b443ce2d1dca4bf50070c492567',
    'referralSource' => 'partner_website',
    'fundSalt' => '0x7189b9ff31064f2bbc98ad4e92e5562c00000000000000000000000000000000',
    'chainId' => 1
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.endaoment.org/v1/funds"

	payload := strings.NewReader("{\n  \"fundInput\": {\n    \"name\": \"Doe Family Foundation\",\n    \"advisor\": {\n      \"firstName\": \"John\",\n      \"lastName\": \"Doe\",\n      \"email\": \"john.doe@example.com\",\n      \"address\": {\n        \"line1\": \"123 Main Street\",\n        \"city\": \"San Francisco\",\n        \"line2\": \"Suite 100\",\n        \"state\": \"CA\",\n        \"zip\": \"94105\",\n        \"country\": \"USA\"\n      }\n    },\n    \"description\": \"A family foundation dedicated to supporting educational initiatives\",\n    \"type\": \"Private\"\n  },\n  \"deploymentTransactionHash\": \"0xf89f7da1e5d79dcb1b8863d0926fe41204785b443ce2d1dca4bf50070c492567\",\n  \"referralSource\": \"partner_website\",\n  \"fundSalt\": \"0x7189b9ff31064f2bbc98ad4e92e5562c00000000000000000000000000000000\",\n  \"chainId\": 1\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.endaoment.org/v1/funds")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"fundInput\": {\n    \"name\": \"Doe Family Foundation\",\n    \"advisor\": {\n      \"firstName\": \"John\",\n      \"lastName\": \"Doe\",\n      \"email\": \"john.doe@example.com\",\n      \"address\": {\n        \"line1\": \"123 Main Street\",\n        \"city\": \"San Francisco\",\n        \"line2\": \"Suite 100\",\n        \"state\": \"CA\",\n        \"zip\": \"94105\",\n        \"country\": \"USA\"\n      }\n    },\n    \"description\": \"A family foundation dedicated to supporting educational initiatives\",\n    \"type\": \"Private\"\n  },\n  \"deploymentTransactionHash\": \"0xf89f7da1e5d79dcb1b8863d0926fe41204785b443ce2d1dca4bf50070c492567\",\n  \"referralSource\": \"partner_website\",\n  \"fundSalt\": \"0x7189b9ff31064f2bbc98ad4e92e5562c00000000000000000000000000000000\",\n  \"chainId\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.endaoment.org/v1/funds")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"fundInput\": {\n    \"name\": \"Doe Family Foundation\",\n    \"advisor\": {\n      \"firstName\": \"John\",\n      \"lastName\": \"Doe\",\n      \"email\": \"john.doe@example.com\",\n      \"address\": {\n        \"line1\": \"123 Main Street\",\n        \"city\": \"San Francisco\",\n        \"line2\": \"Suite 100\",\n        \"state\": \"CA\",\n        \"zip\": \"94105\",\n        \"country\": \"USA\"\n      }\n    },\n    \"description\": \"A family foundation dedicated to supporting educational initiatives\",\n    \"type\": \"Private\"\n  },\n  \"deploymentTransactionHash\": \"0xf89f7da1e5d79dcb1b8863d0926fe41204785b443ce2d1dca4bf50070c492567\",\n  \"referralSource\": \"partner_website\",\n  \"fundSalt\": \"0x7189b9ff31064f2bbc98ad4e92e5562c00000000000000000000000000000000\",\n  \"chainId\": 1\n}"

response = http.request(request)
puts response.read_body

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Doe Family Foundation",
  "type": "Private",
  "manager": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "walletAddress": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e"
  },
  "chainId": 1,
  "advisor": {
    "firstName": "John",
    "lastName": "Doe"
  },
  "featuredIndex": 1,
  "usdcBalance": "20500000",
  "availableBalance": "21000000",
  "description": "A family foundation dedicated to supporting educational initiatives",
  "createdAtUtc": "2024-01-01T00:00:00Z",
  "updatedAtUtc": "2024-03-14T12:00:00Z",
  "lifetimeDonationsUsdc": "1000000000",
  "inboundFeeBps": 25,
  "outboundFeeBps": 50,
  "grantsGiven": 10,
  "inTransitBuyUsdcAmount": "5000000",
  "inTransitSellUsdcAmount": "3000000",
  "investedUsdc": "50000000",
  "totalGrantedUsdc": "25000000",
  "processingTransfersTotalUsdc": "1000000",
  "illiquidBalance": "10000000",
  "poolDetails": {
    "eligibleEntities": "Organizations",
    "algorithmType": "QuadraticFunding",
    "distributionSchedule": "Quarterly",
    "distributionPercentage": 0.25,
    "eligibleVotes": "GrantsAndDonations",
    "voteWeight": "UsdcValue"
  },
  "expectedDeploymentInfo": {
    "expectedManagerAddress": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
    "expectedSalt": "0x0000000000000000000000000000000000000000000000000000000000000123",
    "expectedComputedAddress": "0x1234567890123456789012345678901234567890",
    "expectedChainId": 1
  },
  "deploymentTransactionHash": "0xf89f7da1e5d79dcb1b8863d0926fe41204785b443ce2d1dca4bf50070c492567",
  "contractAddress": "0x1234567890123456789012345678901234567890",
  "lastBalanceSyncUtc": "2024-03-14T12:00:00Z",
  "shortDescription": "Supporting education",
  "vanityUrl": "doe-family-foundation",
  "paypalId": "123e4567-e89b-12d3-a456-426614174000",
  "logo": "https://example.com/logo.png",
  "category": "Education",
  "customFeeDetail": "Special Community Fund Agreement",
  "v2ContractAddress": "<string>"
}

{
  "statusCode": 400,
  "message": [
    "fundInput.advisor.firstName must be a non-empty string",
    "fundInput.advisor.lastName must be a non-empty string",
    "fundInput.advisor.email must be an email",
    "fundInput.advisor.address.zip must be shorter than or equal to 255 characters",
    "fundInput.advisor.address.zip must be a string",
    "\"1\" is not a chain id supported by the system"
  ],
  "error": "Bad Request"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

fundInput

object

required

Details of the fund to be created

Show child attributes

deploymentTransactionHash

object

Transaction hash of the fund contract deployment:
  - If provided, the fund will be created using the information from the deployment transaction provided.
  - If not provided, creates the fund and delegates the blockchain logic to Endaoment.
  - Must be a valid Ethereum transaction hash matching pattern: 0x followed by 64 hexadecimal characters (0-9, a-f)

Example:

"0xf89f7da1e5d79dcb1b8863d0926fe41204785b443ce2d1dca4bf50070c492567"

referralSource

string

Referral source informed by the user for the fund creation

Example:

"partner_website"

fundSalt

object

Random Bytes32 Hex Value used as an idempotency key for fund creation. If not provided, backend will generate one. Note: Off-chain creation requests without salt will not have idempotency guarantees on retries.

Example:

"0x7189b9ff31064f2bbc98ad4e92e5562c00000000000000000000000000000000"

chainId

number

Chain ID to process the fund deployment.

- If not provided, the API will process the fund deployment on the default chain.
- If provided, must be a valid Ethereum chain ID.
- Must be provided if a transaction hash is provided so the backend can fetch the correct deployment from the selected blockchain.

Example:

1

Response

The fund has been successfully created and processed.

string

required

Unique identifier of the fund

Example:

"123e4567-e89b-12d3-a456-426614174000"

name

string

required

Name of the fund

Example:

"Doe Family Foundation"

type

enum<string>

required

Access type of the fund

Available options:

Private,

Community,

Transparent,

ImpactPool

Example:

"Private"

manager

object

required

Basic information about the fund manager. The manager has technical capability to interact with the blockchain and perform programmatic functions.

Show child attributes

chainId

number

required

Chain ID where the fund is deployed

Example:

1

advisor

object

required

Fund advisor information. The advisor is tied to a real-world person/entity and acts as the public contact for the fund. This can be the same person as the manager or someone the manager acts on behalf of.

Show child attributes

featuredIndex

number

required

Index determining the fund's position in featured listings. Lower numbers appear first

Example:

1

usdcBalance

string

required

Current synced USDC balance in the smallest currency unit (1000000 = 1 USD). This does not account for asynchronous grants, asynchronous entity transfers, or asynchronous investments that may still be processing.

Example:

"20500000"

availableBalance

string

required

Amount available to grant or transfer in the smallest currency unit (1000000 = 1 USD), adjusted for invested value, in-transit portfolio operations, and pending asynchronous transfers.

Example:

"21000000"

description

string

required

Detailed description of the fund

Example:

"A family foundation dedicated to supporting educational initiatives"

createdAtUtc

string

required

UTC timestamp of fund creation

Example:

"2024-01-01T00:00:00Z"

updatedAtUtc

string

required

UTC timestamp of last fund update

Example:

"2024-03-14T12:00:00Z"

lifetimeDonationsUsdc

string

required

Total lifetime donations received in USDC, in the smallest currency unit (1000000 = 1 USD)

Example:

"1000000000"

inboundFeeBps

number

required

The fee charged for inbound operations in basis points (1 basis point = 0.01%)

Example:

25

outboundFeeBps

number

required

The fee charged for outbound operations in basis points (1 basis point = 0.01%)

Example:

50

grantsGiven

number

required

Total number of grants given by this fund

Example:

10

inTransitBuyUsdcAmount

string

required

Amount of USDC pending purchase in the smallest currency unit (1000000 = 1 USD)

Example:

"5000000"

inTransitSellUsdcAmount

string

required

Amount of USDC pending sale in the smallest currency unit (1000000 = 1 USD)

Example:

"3000000"

investedUsdc

string

required

Total amount invested in USDC, in the smallest currency unit (1000000 = 1 USD)

Example:

"50000000"

totalGrantedUsdc

string

required

Total amount granted in USDC, in the smallest currency unit (1000000 = 1 USD)

Example:

"25000000"

processingTransfersTotalUsdc

string

required

Total amount in processing transfers in USDC, in the smallest currency unit (1000000 = 1 USD)

Example:

"1000000"

illiquidBalance

string

required

Total balance in illiquid portfolios in USDC, in the smallest currency unit (1000000 = 1 USD)

Example:

"10000000"

poolDetails

object | null

required

Impact Pool specific details. Only available for Impact Pool type funds

Show child attributes

expectedDeploymentInfo

object | null

required

Information needed for on-chain deployment. Only available for funds not yet deployed

Show child attributes

deploymentTransactionHash

object | null

Transaction hash of the deployment transaction

Example:

"0xf89f7da1e5d79dcb1b8863d0926fe41204785b443ce2d1dca4bf50070c492567"

contractAddress

string | null

Contract address of the fund

Example:

"0x1234567890123456789012345678901234567890"

lastBalanceSyncUtc

string | null

UTC timestamp of the last balance sync

Example:

"2024-03-14T12:00:00Z"

shortDescription

object | null

Brief description of the fund

Example:

"Supporting education"

vanityUrl

string | null

Custom URL identifier for the fund

Example:

"doe-family-foundation"

paypalId

object | null

PayPal merchant ID associated with the fund

Example:

"123e4567-e89b-12d3-a456-426614174000"

logo

object | null

URL of the fund's logo image

Example:

"https://example.com/logo.png"

About

Quickstart

Endpoints

Smart Contracts

Create fund

Authorizations

Body

Response