🛠️API Documentation

Creating a market segment is easy with DeepDAO's API

APi Endpoints

Create a list

Create a new whitelist

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 [e-mail] 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.

POST//v0.1/create_marketing_list

Authorization

x-api-key

Body

application/json

descriptionnullable string

description of the list.

Example: "DeFi and NFT voters from Gnosis and ENS"

listTypenullable string

type of the list (user defined)

Example: "DeFi and NFT voters"

startDatenullable string (date-time)

the start date of a timeframe.

endDatenullable string (date-time)

the end date of a timeframe.

categoriesnullable array of string (uuid)

list of categories by uuid

governancePlatformnullable array of number

list of governance platforms by number

treasurySizeMinnullable number

minimum treasury size of users' organizations

Example: 100

treasurySizeMaxnullable number

maximum treasury size of users' organizations

Example: 200000

organizationsnullable array of string

list of organizations by uuid

Response

201

Request

JavaScriptCurlPython

const response = await fetch('//v0.1/create_marketing_list', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Use the list

Get specific address’s eligibility for a given white list

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

GET//v0.1/is_address_in_marketing_list/{list_id}/address/{address}

Authorization

x-api-key

Path parameters

list_id*number

white list id

address*string

address

Response

200

Body

application/json

object

Request

JavaScriptCurlPython

const response = await fetch('//v0.1/is_address_in_marketing_list/{list_id}/address/{address}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get a list metadata

Get specific white list

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

GET//v0.1/get_marketing_list/{list_id}

Authorization

x-api-key

Path parameters

list_id*number

white list id

Response

200

Request

JavaScriptCurlPython

const response = await fetch('//v0.1/get_marketing_list/{list_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get all your lists' metadata

Get all user's whitelists

Get all the lists you created so far.

GET//v0.1/get_marketing_lists

Authorization

x-api-key

Response

200

Request

JavaScriptCurlPython

const response = await fetch('//v0.1/get_marketing_lists', {
    method: 'GET',
    headers: {},
});
const data = await response.json();