Skip to main content
GET
Your invite link and how many invitees signed up (3 unlock the 50M US dataset and the co-op file)

Authorizations

Authorization
string
header
required

Token <your API key>

Response

200 - application/json

{"invite_link": ..., "signed_up": 0, "needed": 3, "unlocks": ..., "unlocks_ranks": ["coop", "us_50m"]}

Your own signup link: whoever signs up through it is your invitee.

signed_up
integer
required

How many people you invited have signed up and verified their email. People on your own email domain and deactivated accounts don't count.

needed
integer
required

How many signed-up invitees unlock the files in unlocks_ranks.

unlocks
string
required

What reaching needed unlocks, in words, and that 50 USD of credit bought unlocks only the co-op file.

unlocks_ranks
string[]
required

The ranks in GET /files/ that reaching needed unlocks.