DeepDAO Product Documentation
  • DeepDAO Products
  • 👋Governance List: the Top DAOists
    • ✨Getting Started
    • 💡How to use our Top People API?
    • 🛠️API Documentation
    • 🏹DAO Participation Score
    • 🎨Use case: Incentive Campaign
    • 🖥️Use case: Promoting a DAO Tool
    • 🫂Use case: Starting a DAO
    • 🎨Use case: Academic research
  • ❤️DAO Ecosystem
  • 👑DAO Analytics
  • 🫂DAO Coalition Building
Powered by GitBook
On this page
  1. Governance List: the Top DAOists

API Documentation

Creating a market segment is easy with DeepDAO's API

PreviousHow to use our Top People API?NextDAO Participation Score

Last updated 2 years ago

APi Endpoints

Create a list

Use the list

Get a list metadata

Get all your lists' metadata

👋
🛠️

Get specific address’s eligibility for a given white list

get

Check if an address is included in a specific marketing list you created.

Authorizations
Path parameters
list_idnumberRequired

white list id

addressstringRequired

address

Responses
200Success
application/json
Responseobject
get
GET /is_address_in_marketing_list/{list_id}/address/{address} HTTP/1.1
Host: v0.1
x-api-key: YOUR_API_KEY
Accept: */*
200Success
{}

Get specific white list

get

Get the criteria you are using in the specified marketing list.

Authorizations
Path parameters
list_idnumberRequired

white list id

Responses
200Success
get
GET /get_marketing_list/{list_id} HTTP/1.1
Host: v0.1
x-api-key: YOUR_API_KEY
Accept: */*
200Success
No content

Get all user's whitelists

get

Get all the lists you created so far.

Authorizations
Responses
200Success
get
GET /get_marketing_lists HTTP/1.1
Host: v0.1
x-api-key: YOUR_API_KEY
Accept: */*
200Success
No content
  • APi Endpoints
  • Create a list
  • POSTCreate a new whitelist
  • Use the list
  • GETGet specific address’s eligibility for a given white list
  • Get a list metadata
  • GETGet specific white list
  • Get all your lists' metadata
  • GETGet all user's whitelists

Create a new whitelist

post

DeepDAO’s marketing API allows our users to create market segmentations of voters across all DAOs listed on our platforms. The create_marketing_list call is where you start. Use it to create a new market segment of voters based on several criteria: * Categories: select from the DeepDAO categories those that make sense for your needs. You can select zero or multiple categories. If you select zero categories, we will include voters from all of them. * Organizations: In addition to categories, you can add voters from certain organizations that make sense for you. You can select zero or multiple organizations. If you select zero organizations, we will include voters from all of them. * Treasury size: if you select a minimum and / or maximum treasury size, we will include voters only from organizations within this treasury range. * Governance platform: you can restrict voters, so that they only voted on certain governance systems. For example you can choose Snapshot (off-chain), or Compound Governance (on-chain) or both, or all of the DeepDAO supported platforms. * Start date / end date: you can restrict your market segment to people (addresses) who voted only between two dates. Note: the listType parameter is currently not in use. You can ignore it. Which wallet addresses are eligible for being included in my marketing list? The marketing list you created is a segment of confirmed voters. Each person (address) included in DeepDAO’s marketing segments, voted at least once in a DAO. How do I reach the people on my list? There are several options. * Use our is_address_in_marketing_list call to check if an address is included in your list. * Use DeepDAO’s platform to contact these people (addresses) directly through notifications, or banners. Please write to us at info@deepdao.io for more information. * Use any of the address to address chat apps, or address to address mail apps (you can find some of them in DeepDAO’s Tools dashboard) to contact them directly.

Authorizations
Body
descriptionstring | nullableOptional

description of the list.

Example: DeFi and NFT voters from Gnosis and ENS
listTypestring | nullableOptional

type of the list (user defined)

Example: DeFi and NFT voters
startDatestring · date-time | nullableOptional

the start date of a timeframe.

endDatestring · date-time | nullableOptional

the end date of a timeframe.

categoriesstring · uuid[] | nullableOptional

list of categories by uuid

Example: ["6b5e506e-22f1-4bdc-bbbb-5f286566ce96","1011857f-9223-480d-a67b-5b74890f1111"]
governancePlatformnumber[] | nullableOptional

list of governance platforms by number

Example: [11,12]
treasurySizeMinnumber | nullableOptional

minimum treasury size of users' organizations

Example: 100
treasurySizeMaxnumber | nullableOptional

maximum treasury size of users' organizations

Example: 200000
organizationsstring[] | nullableOptional

list of organizations by uuid

Example: ["228c8be1-9d1e-440c-8afb-a40d6ee480f2","529571a8-5816-47ff-a50e-1e6372e2324b"]
Responses
201Success
post
POST /create_marketing_list HTTP/1.1
Host: v0.1
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 431

{
  "description": "DeFi and NFT voters from Gnosis and ENS",
  "listType": "DeFi and NFT voters",
  "startDate": "2025-06-07T12:33:31.622Z",
  "endDate": "2025-06-07T12:33:31.622Z",
  "categories": [
    "6b5e506e-22f1-4bdc-bbbb-5f286566ce96",
    "1011857f-9223-480d-a67b-5b74890f1111"
  ],
  "governancePlatform": [
    11,
    12
  ],
  "treasurySizeMin": 100,
  "treasurySizeMax": 200000,
  "organizations": [
    "228c8be1-9d1e-440c-8afb-a40d6ee480f2",
    "529571a8-5816-47ff-a50e-1e6372e2324b"
  ]
}
201Success
No content