Introduction
The Flippa API provides programmatic access to data and operations on flippa.com.
Libraries
Libraries are available for select languages to help consume the API.
Language | Library |
---|---|
JavaScript | flippa-js |
Authentication
Client Credentials Grant
flippa.authenticate({
grant_type: "client_credentials",
client_id: 123,
client_secret: "shh"
})
curl https://api.flippa.com/v3/oauth2/token \
-d grant_type=client_credentials \
-d client_id=123 \
-d client_secret=shh
{
"access_token": "6a853b20a67d41fc199e635071e45a7cf3fff927",
"token_type": "bearer"
}
HTTP Request
POST https://api.flippa.com/v3/oauth2/token
Parameters
Parameter | Description |
---|---|
grant_type | The type of the requested grant. Should be ‘client_credentials’. |
client_id | The ID of the client to authenticate. |
client_secret | The secret of the client to authenticate. |
Password Grant
flippa.authenticate({
grant_type: "password",
client_id: 123,
username: "ziggy"
password: "stardust"
})
curl https://api.flippa.com/v3/oauth2/token \
-d grant_type=password \
-d client_id=123 \
-d username=ziggy \
-d password=stardust
{
"access_token": "6a853b20a67d41fc199e635071e45a7cf3fff927",
"token_type": "bearer"
}
HTTP Request
POST https://api.flippa.com/v3/oauth2/token
Parameters
Parameter | Required | Description |
---|---|---|
grant_type | yes | The type of the requested grant. Should be 'password’. |
client_id | no | The ID of the client to authenticate. |
username | yes | The username (or email address) of the user to authenticate as. |
password | yes | The password of the user to authenticate as. |
Login Cookie Grant
This grant type is limited to Flippa usage only.
flippa.authenticate({
grant_type: "login_cookie",
client_id: 123,
}, {
utok: "userlogincookie"
})
curl https://api.flippa.com/v3/oauth2/token \
-d grant_type=login_cookie \
-d client_id=123 \
-b "utok=userlogincookie"
{
"access_token": "6a853b20a67d41fc199e635071e45a7cf3fff927",
"token_type": "bearer"
}
HTTP Request
POST https://api.flippa.com/v3/oauth2/token
The request should be made with a valid Flippa login cookie named utok
.
Parameters
Parameter | Description |
---|---|
grant_type | The type of the requested grant. Should be 'login_cookie’. |
client_id | The ID of the client to authenticate. |
Making Authenticated Requests
In order to make an authenticated request, a client should provide a valid access token via the Authorization header.
curl https://api.flippa.com/v3/listings \
-H "Authorization: Bearer sometoken"
All API requests must be made over HTTPS. Clients must authenticate for all requests, except for when obtaining an access token.
Pagination
{
"meta": {
"page_number": 3,
"page_size": 30,
"total_results": 200
},
"links": {
"prev": "https://api.flippa.com/v3/listings?page%5Bnumber%5D=2&page%5Bsize%5D=30",
"next": "https://api.flippa.com/v3/listings?page%5Bnumber%5D=4&page%5Bsize%5D=30"
}
}
Collection endpoints may paginate the results returned.
If so, the response body will include next
and prev
links in the top-level
links
object along with the number of total results in the top-level meta
object.
If there is no next or previous page, the next
or prev
key will still be
present but will have a null
value.
You can request specific pages using the page[number]
parameter, and specific
page sizes with the page[size]
parameter. page[size]
must be an integer
between 1 and 250. All paginated requests are currently limited to the first
200 pages. The product of page[number] - 1
and page[size]
may not exceed 20000.
Errors
https://api.flippa.com/v3/listings?page[number]=seven&page[size]=twelve
{
"errors": [
{
"status": 400,
"code": "bad_request.invalid_parameter",
"detail": "Page number must be a positive integer."
},
{
"status": 400,
"code": "bad_request.invalid_parameter",
"detail": "Page size must be a positive integer between 1 and 250."
}
]
}
Flippa uses standard HTTP response codes to indicate request success or failure.
The 2xx range indicates success, the 4xx range indicates one or more errors with a client request, and the 5xx range indicates an internal Flippa failure.
An error response will contain a top level errors
array (even when there is
only a single error) containing details of the errors.
Bad Request (400)
Type | Description |
---|---|
bad_request.invalid_parameter | The request included an invalid parameter. |
Unauthorized (401)
Type | Description |
---|---|
unauthorized | The request did not include valid authorization. |
Forbidden (403)
Type | Description |
---|---|
forbidden | The request was not permitted for the provided authorization. |
Not Found (404)
Type | Description |
---|---|
not_found | The specified resource could not be found. |
Internal Server Error (500)
Type | Description |
---|---|
internal_server_error | Flippa encountered an unexpected error processing the request. |
Types
Boolean
A string with special characteristics. It interprets the following
values as false: ""
, "0"
, "F"
, "false"
. Any other value is considered
true. In general usage, it is expected to pass T
for true and F
for false.
Integer (Multiple)
One or more integers. When specifying multiple values, separate with a comma
and no intervening whitespace e.g. 1,2,3
.
Integer (Range)
Singular or range of integers specified via min
and/or max
inclusive limits.
curl https://api.flippa.com/v3/listings?filter[price]=1000
curl https://api.flippa.com/v3/listings?filter[price][min]=500&filter[price][max]=1500
filter.listings.list({filter: {price: 1000}})
flippa.listings.list({
filter: {
price: {
min: 500,
max: 1500
}
}
})
ListingStatus
The status of a Listing.
Value | Description |
---|---|
open | The listing is live on Flippa. |
won | The listing has ended and resulted in a sale. |
completed | The listing has ended, but has not resulted in sale. |
PropertyType
The type of property in a Listing.
Value | Description |
---|---|
android_app | Android App. |
domain | Domain. |
established_website | Established Website. |
ios_app | iOS App. |
starter_site | Starter Site. |
When used as a filter parameter, aggreggate values of website
and app
can
be used to retrieve both established websites and starter sites, or iOS apps
and Android apps respectively.
Listings
List all Listings
flippa.listings.list()
curl https://api.flippa.com/v3/listings
{
"meta": {
"total_results": 100,
"page_number": 1,
"page_size": 30
},
"links": {
"prev": null,
"next": "https://api.flippa.com/v3/listings?page%5Bnumber%5D=2&page%5Bsize%5D=30"
},
"data": [
{
"type": "listings",
"id": "2",
"app_downloads_per_month": null,
"bid_count": 1,
"buy_it_now_price": null,
"confidential": false,
"current_price": 1000,
"ends_at": "2016-04-28T12:25:18+10:00",
"established_at": "2014-08-01T12:00:00+10:00",
"external_url": "http://bar.com/",
"has_verified_revenue": false,
"has_verified_traffic": false,
"html_url": "https://flippa.com/2",
"hostname": "bar.com",
"page_views_per_month": 2000,
"post_auction_negotiable": false,
"profit_per_month": 3000,
"property_name": "bar.com",
"property_type": "domain",
"reserve_met": true,
"revenue_per_month": 5000,
"revenue_sources": ["affiliate"],
"sale_method": "classified",
"starts_at": "2015-07-01T12:00:00+10:00",
"status": "open",
"summary": "A summary by the seller of the listing",
"thumbnail_url": "https://cdn.flippa.com/2-bar.jpg",
"title": "bar.com is for sale",
"uniques_per_month": 1000,
"watching": false,
"relationships": {
"seller": {
"data": {
"type": "users",
"id": "123"
},
"links": {
"self": "https://api.flippa.com/v3/users/123"
}
},
"tags_site_type": {
"links": {
"self": "https://api.flippa.com/v3/listings/2/site_type_tags"
}
},
"tags_monetization": {
"links": {
"self": "https://api.flippa.com/v3/listings/2/monetization_tags"
}
},
"categories": {
"links": {
"self": "https://api.flippa.com/v3/listings/2/categories"
}
},
"upgrades": {
"links": {
"self": "https://api.flippa.com/v3/listings/2/upgrades"
}
}
},
"links": {
"self": "https://api.flippa.com/v3/listings/2"
}
},
{
"type": "listings",
"id": "1",
"app_downloads_per_month": null,
"bid_count": null,
"buy_it_now_price": 1000,
"confidential": false,
"current_price": 1,
"ends_at": "2015-08-01T12:00:00+10:00",
"established_at": "2014-08-01T12:00:00+10:00",
"external_url": "http://foo.com/",
"html_url": "https://flippa.com/1",
"page_views_per_month": 2000,
"profit_per_month": 3000,
"property_name": "foo.com",
"property_type": "established_website",
"reserve_met": false,
"revenue_per_month": 5000,
"revenue_sources": ["product_sales", "advertising"],
"sale_method": "auction",
"starts_at": "2015-07-01T12:00:00+10:00",
"status": "open",
"summary": "A summary by the seller of the listing",
"thumbnail_url": "https://cdn.flippa.com/1-foo.jpg",
"title": "foo.com is for sale",
"uniques_per_month": 1000,
"watching": false,
"relationships": {
"seller": {
"data": {
"type": "users",
"id": "456"
},
"links": {
"self": "https://api.flippa.com/v3/users/456"
}
},
"tags_site_type": {
"links": {
"self": "https://api.flippa.com/v3/listings/1/site_type_tags"
}
},
"tags_monetization": {
"links": {
"self": "https://api.flippa.com/v3/listings/1/monetization_tags"
}
},
"categories_top_level": {
"links": {
"self": "https://api.flippa.com/v3/listings/1/categories"
}
},
"upgrades": {
"links": {
"self": "https://api.flippa.com/v3/listings/2/upgrades"
}
}
},
"links": {
"self": "https://api.flippa.com/v3/listings/1"
}
}
]
}
By default, listings are returned sorted in descending order of creation time.
This resource is paginated.
HTTP Request
GET https://api.flippa.com/v3/listings
Filter Parameters
Parameter | Type | Description |
---|---|---|
age | Integer (Range) | Restrict results to those aged between a minimum and/or maximum number of months |
broker_seller | Boolean | Restrict results to only listings from broker sellers |
business_model | String (Multiple) | Restrict results to listings with the given business models (e.g. ‘adsense,amazon’) |
category | String (Multiple) | Restrict results to listings with the given categories (e.g. 'automotive,internet’) |
domain_characters_count | Integer (Range) | Restrict results to those with a matching number of characters in the SLD |
domain_without_numbers | Boolean | Restrict results to only SLDs without numbers |
domain_without_special_characters | Boolean | Restrict results to those whose SLDs do not contain special characters |
domain_word_count | Integer (Multiple) | Restrict results to those containing the given number of words |
downloads_per_month | Integer (Range) | Restrict results to those with the given number of downloads per month, verified or not |
end | Integer (Range) | Restricts results to those with an end time between a minimum and/or maximum number of hours from now |
exclude_characters | String (Multiple) | Restricts results to those whose SLDs do not contain specified characters (Maximum of 6 characters to be excluded) |
has_bin | Boolean | Restrict results to those with a “Buy It Now” price |
has_verified_revenue | Boolean | Restrict results to those with verified revenue |
has_verified_traffic | Boolean | Restrict results to those with verified traffic |
monetization_method | String (Multiple) | Restrict results to listings with the given monetization method (e.g. 'adsense,amazon’) |
premium | Boolean | Restricts results to listings with the Premium package upgrade |
price | Integer (Range) | Restrict results to listings having the specified current price |
property_name | String | Restrict results to listings with the given property name |
property_type | PropertyType | Restrict results to listings with the given property type |
reserve_met | Boolean | Restrict results to those meeting reserve |
reskin | Boolean | Restricts results to listings that are either reskins or not reskins |
revenue_per_month | Integer (Range) | Restrict results to those with the given revenue per month, verified or not |
revenue_sources | String (Multiple) | Restricts results to listings with the given revenue sources (e.g. 'product,advertising,affiliates’) |
sale_method | String (Multiple) | Restrict results to listings with the given sale methods (e.g. 'auction,classified’) |
status | ListingStatus | Restrict results to listings with the given status |
tld | String (Multiple) | Restrict results to listings with the given TLDs (e.g. 'com,net’) |
uniques_per_month | Integer (Range) | Restrict results to those with the given number of uniques per month, verified or not |
user_id | Integer | Restrict results to listings by the user with the given ID |
pattern | String | Restrict results to listings matching the given pattern. The pattern can consist of 1 to 6 letters or numbers or the following special characters L, N, V, C to match respectively any letter (a-z), any number (0-9), any vowel (a, e, i, o, u) or any consonant. (e.g. 'CVCV’) |
Query Parameter
A query
parameter may be supplied in order to search for listings matching the given query string or hash.
Key | Description |
---|---|
keyword | Query listings according to a keyword |
placement | Query listings based on the placement of the keyword provided (eg. 'starting’, 'ending’, 'exact’) |
flippa.listings.list({query: 'cat'})
flippa.listings.list({query: {keyword: 'cat', placement: 'starting'})
curl "https://api.flippa.com/v3/listings?query=cat"
curl "https://api.flippa.com/v3/listings?query=cat&placement=starting"
Sort Alias Parameters
Sort aliases are a non-reversible mapping onto one or more listing columns.
Specifying a sort alias will override the sorts naturally applied by the search
template. Sort aliases are specified in the form sort_alias=key
. It is only
possible to specify one sort alias at a time.
Key | Description |
---|---|
most_active | Sort listings according to a descending bid count. |
lowest_price | Sort listings by ascending current price. |
highest_price | Sort listings by descending current price. |
most_recent | Sort listings by most recently started. |
ending_soonest | Sort listings by ascending end date. |
most_profitable | Sort listings by descending average monthly profit. |
Search Templates
Search templates represent a set of pre-configured filters and sorts.
They can be requested using the search_template
parameter.
Key | Description |
---|---|
default | Open and post-auction negotiable listings, ordered by most recently created first. |
apps_ending_soon | Open app listings, sorted by ending soonest then quality. |
apps_most_active | Open app listings, sorted by most bids then quality. |
apps_reserve_met | Open app listings that have met reserve, sorted by quality. |
deal_flow | Open Deal Flow listings, most recently listed first. |
domains_brokered | Open domain listings, brokered, sorted by quality. |
domains_ending_soon | Open domain listings, sorted by ending soonest then quality. |
domains_most_active | Open domain listings, sorted by most bids then quality. |
domains_reserve_met | Open domain listings that have met reserve, sorted by quality. |
editors_choice | Editors’ choice listings that are currently open, sorted by ending soonest then quality. |
featured | Open listings that have been “homepage featured”, sorted by most recently featured. |
property_featured | Open listings that have been “property homepage featured”, sorted by most recently featured. |
just_sold | Recently won listings, sorted by greatest sale price first. |
websites_ending_soon | Open website listings, sorted by ending soonest then quality. |
websites_most_active | Open website listings, sorted by most bids then quality. |
websites_reserve_met | Open website listings that have met reserve, sorted by quality. |
websites_established_sites | Open established sites listings, sorted by quality. |
websites_starter_sites | Open starter sites listings, sorted by quality. |
Retrieve a Listing
flippa.listing(1).retrieve()
curl "https://api.flippa.com/v3/listings/1"
{
"data": {
"type": "listings",
"id": "1",
"app_downloads_per_month": null,
"bid_count": 1,
"buy_it_now_price": 1000,
"confidential": false,
"current_price": 1,
"ends_at": "2015-08-01T12:00:00+10:00",
"established_at": "2014-08-01T12:00:00+10:00",
"external_url": "http://foo.com/",
"html_url": "https://flippa.com/1",
"page_views_per_month": 2000,
"profit_per_month": 3000,
"property_name": "foo.com",
"property_type": "established_website",
"reserve_met": false,
"revenue_per_month": 5000,
"revenue_sources": ["product_sales", "advertising", "affiliate"],
"sale_method": "auction",
"starts_at": "2015-07-01T12:00:00+10:00",
"status": "open",
"summary": "A summary by the seller of the listing",
"thumbnail_url": "https://cdn.flippa.com/1-foo.jpg",
"title": "foo.com is for sale",
"uniques_per_month": 1000,
"watching": false,
"relationships": {
"seller": {
"data": {
"type": "users",
"id": "456"
},
"links": {
"self": "https://api.flippa.com/v3/users/456"
}
},
"tags_site_type": {
"links": {
"self": "http://api.flippa.com/v3/listings/1/site_type_tags"
}
},
"categories_top_level": {
"links": {
"self": "http://api.flippa.com/v3/listings/1/categories"
}
},
"upgrades": {
"links": {
"self": "http://api.flippa.com/v3/listings/1/upgrades"
}
},
"tags_monetization": {
"links": {
"self": "http://api.flippa.com/v3/listings/1/monetization_tags"
}
}
},
"links": {
"self": "https://api.flippa.com/v3/listings/1"
}
}
}
Retrieves the details of a specific listing using its unique ID.
HTTP Request
GET https://api.flippa.com/v3/listings/<ID>
URL Parameters
Parameter | Description |
---|---|
ID | The ID of the listing to retrieve. |
Relationships
You may request to have relationship’s data be included directly into the
response by providing on or more values as the include
parameter.
When an association is include
d, it will create entries in both the
relationships
section of every data
object returned, as well as the
included
top-level section of the response.
flippa.listings.list({include: 'tags_site_type'})
curl "https://api.flippa.com/v3/listings?include=tags_site_type"
Include Parameter
Value | Aliases | Description |
---|---|---|
categories_top_level | categories | Top level categories of the listing. |
tags_site_type | tags | Tags on the listing that have the “site type” tag. |
tags_monetization | tags | Tags on the listing that have the “monetization” tag. |
upgrades | upgrades | Purchased upgrades of the listing. |
Relationships Section
When an association is one to many, the relationships section contains only
links and no data. When an include
is specified, the relationships section is
populated with an array of “relationship objects”. A relationship object
contains a type and ID that can be used to locate the data from the included
top-level section.
{
"data": {
"relationships": {
"tags": {
"data": [
{
"type": "tags",
"id": "1"
},
{
"type": "tags",
"id": "2"
}
],
"links": {
"self": "https://api.flippa.com/v3/listings/2/tags"
}
}
}
}
}
“Included” Section
The included section is a flat array of included data from the whole collection. Each type + ID combination is considered to be a unique identifier.
{
"data": [
{}, {}, {}
],
"included": [
{
"type": "tags",
"id": 1,
"category": "sitetype",
"value": "blog",
"title": "Blog"
},
{
"type": "tags",
"id": 2,
"category": "sitetype",
"value": "ecommerce",
"title": "E-Commerce"
}
]
}
Relationship fields
categories
Value | Type | Description |
---|---|---|
slug | String | The slug representation of the category |
name | String | The human-readable name of the category |
tags
Value | Type | Description |
---|---|---|
category | String | The type of tag e.g. “sitetype” |
value | String | A slug representation of the tag |
title | String | A human-readable representation of the tag |
upgrades
Value | Type | Description |
---|---|---|
package | String | The human-readable name of the package the upgrade belongs to |
upgradekey | String | The human-readable name of the upgrade |
Listings Field Descriptions
revenue_sources
The revenue sources of a listing as indicated by the seller. There are six categories of revenue source recognised by Flippa, and all or none may be present on a listing.
Value | Description |
---|---|
advertising | Advertising |
advertising_sales | Advertising Sales |
affiliate | Affiliate Income |
app_sales | App Sales |
in_app_sales | In-App Sales |
product_sales | Product or Service Sales |
Alerts
List Alerts for a User
flippa.user(123).listAlerts()
curl https://api.flippa.com/v3/users/123/alerts
{
"meta": {
"pending_bids_count": 1,
"pending_offers_count": 2,
"unread_messages_count": 5
}
}
Retrieves the alerts for the given user. This is currently just metadata (counts).
HTTP Request
GET https://api.flippa.com/v3/users/123/alerts
Careers
List all Careers
flippa.careers.list()
curl https://api.flippa.com/v3/careers
{
"meta": {
"total_results": 10,
"page_number": 1,
"page_size": 30
},
"links": {
"prev": null,
"next": "https://api.flippa.com/v3/careers?page%5Bnumber%5D=2&page%5Bsize%5D=30"
},
"data": [
{
"type": "careers",
"id": "2",
"title": "Web Developer",
"location": "Melbourne, Australia",
"description": "<p>Flippa is looking for devs — senior through to junior — who want to work in a small but high-class team that gets stuff done.</p>",
"path": "web-developer",
"links": {
"self": "https://api.flippa.com/v3/careers/2"
}
},
{
"type": "careers",
"id": "1",
"title": "Customer Service Representative",
"location": "San Francisco, USA",
"description": "<p>We are looking for a Customer Service Representative who can join our existing support team to answer questions, facilitate transactions and help buyers and sellers work together.</p>",
"path": "customer-service-representative",
"links": {
"self": "https://api.flippa.com/v3/careers/1"
}
},
]
}
By default, careers are returned sorted in descending order of creation time.
This resource is paginated.
HTTP Request
GET https://api.flippa.com/v3/careers
Retrieve a Career
flippa.career(1).retrieve()
curl "https://api.flippa.com/v3/careers/1"
{
"data": {
"type": "careers",
"id": "1",
"title": "Customer Service Representative",
"location": "San Francisco, USA",
"description": "<p>We are looking for a Customer Service Representative who can join our existing support team to answer questions, facilitate transactions and help buyers and sellers work together.</p>",
"path": "customer-service-representative",
"links": {
"self": "https://api.flippa.com/v3/careers/1"
}
}
}
Retrieves the details of a specific career using its unique ID.
HTTP Request
GET https://api.flippa.com/v3/careers/<ID>
URL Parameters
Parameter | Description |
---|---|
ID | The ID of the career to retrieve. |
Domain Traits
List Domain Traits for a Listing
flippa.listing(123).listDomainTraits()
curl https://api.flippa.com/v3/listings/123/domain-traits
{
"data": [
{
"type": "domain-traits",
"id": "memorable_one_word"
},
{
"type": "domain-traits",
"id": "premium"
},
{
"type": "domain-traits",
"id": "verified"
}
]
}
Retrieves the collection of what Flippa considers to be the traits of the domain listed with the given Listing ID. These may change at any time.
HTTP Request
GET https://api.flippa.com/v3/listings/123/domain-traits
Leads
Creating a Lead
flippa.leads.create({
source: "lead-source-name"
offerer_email: "john@smi.th",
offerer_name: "John Smith",
offerer_phone: "+6123123123",
offer_amount: "50",
offer_message: "I'm interested.",
property_name: "example.com"
})
curl https://api.flippa.com/v3/leads \
-d source="lead-source-name" \
-d offerer_email="john@smi.th" \
-d offerer_name="John Smith" \
-d offerer_phone="+6123123123" \
-d offer_amount=50 \
-d offer_message="I'm interested." \
-d property_name="example.com"
{
"data": {
"type": "leads",
"id": "123"
}
}
This endpoint is limited to Flippa usage only.
HTTP Request
POST https://api.flippa.com/v3/leads
Parameters
Parameter | Required | Description |
---|---|---|
source | yes | Origin of the lead. |
offerer_email | yes | Email address of the offerer. |
offerer_name | yes | Name of the offerer. |
offerer_phone | no | Phone number of the offerer. |
offer_amount | yes | Amount of the offer in US dollars. |
offer_message | no | Message to include with the offer. |
property_name | yes | Name of the property to make an offer on. |
Metrics
List all Metrics
flippa.metrics.list()
curl https://api.flippa.com/v3/metrics
{
"data": [
{
"type": "metrics",
"id": "bids_this_week",
"value": 8602
},
{
"type": "metrics",
"id": "open_listings",
"value": 837288
},
{
"type": "metrics",
"id": "overall_sales",
"value": 143657791
},
{
"type": "metrics",
"id": "sales_this_week",
"value": 548510
}
]
}
Returns a collection of public Flippa metrics.
HTTP Request
GET https://api.flippa.com/v3/metrics
Sales Pages
Retrieve a Sales Page
flippa.salesPage(123).retrieve()
curl https://api.flippa.com/v3/sales-pages/123
{
"data": {
"type": "sales-pages",
"id": "123",
"copy": "example sales page copy"
}
}
HTTP Request
GET https://api.flippa.com/v3/sales-pages/123
Saved Searches
List Saved Searches for the currently authenticated user
flippa.savedSearches().list()
curl https://api.flippa.com/v3/saved-searches
[
{
"id": "1",
"name": "Travel Websites",
"subscribed": true,
"search": {
"filters": {"property_type": "website"},
"query": {"keyword": "travel"},
"search_template": "websites_most_relevant"
}
},
{
"id": "2",
"name": "Travel Apps",
"subscribed": true,
"search": {
"filters": {"property_type": "app"},
"query": {"keyword": "travel"},
"search_template": "websites_most_relevant"
}
}
]
Retrieves the collection of saved searches for the currently authenticated user
Saved searches are returned sorted in descending order of creation time.
HTTP Request
GET https://api.flippa.com/v3/saved-searches
Create a Saved Search
flippa.savedSearches().create({
"name": "Travel Websites",
"search": {
"filters": {"property_type": "website"},
"query": {"keyword": "travel"},
"search_template": "websites_most_relevant"
}
})
curl -XPOST https://api.flippa.com/v3/saved-searches -d '{
"name": "Travel Websites",
"search": {
"filters": {"property_type": "website"},
"query": {"keyword": "travel"},
"search_template": "websites_most_relevant"
}
}'
Creates a saved search for the current authenticated user with the given name and search parameters.
Successful requests have no response body and will respond with a 201 Created
status.
HTTP Request
POST https://api.flippa.com/v3/saved-searches
Delete Saved Search
flippa.savedSearch(1).del()
curl -XDELETE https://api.flippa.com/v3/saved-searches/1
Deletes the saved search with the given ID belonging to the currently authenticated user.
Successful requests have no response body and will respond with a 204 No
Content
status.
HTTP Request
DELETE https://api.flippa.com/v3/saved-searches/1
Sessions
Create a Session
flippa.sessions.create()
curl -X POST https://api.flippa.com/v3/sessions
{
"data": {
"type": "sessions",
"id": "198708fa0fa37b23a6a46ce15d5fe159"
}
}
This endpoint is limited to Flippa usage only.
Creates a flippa.com session for the user associated with the provided access token.
HTTP Request
POST https://api.flippa.com/v3/sessions
Support Enquiries
Creating a Support Enquiry
flippa.supportEnquiries.create({
email: "bob@test.com",
reason: "General Enquiry",
message: "I would like to know more about things in general"
})
curl https://api.flippa.com/v3/support-enquiries \
-d email="bob@test.com" \
-d reason="General Enquiry" \
-d message="I would like to know more about things in general"
Creates a new Support Enquiry.
Successful requests have no response body and will respond with a 204 No Content status.
SupportEnquiries created by an authenticated user will be created on behalf of that user, unless an email is specified.
HTTP Request
POST https://api.flippa.com/v3/support-enquiries
Parameters
Parameter | Required | Description |
---|---|---|
no | The email address of the enquirer | |
message | yes | Detailed explanation of the enquiry |
reason | no | The reason for the support enquiry |
Users
Identifying the authenticated User
flippa.users.identify()
curl https://api.flippa.com/v3/users/identify
{
"data": {
"type": "users",
"id": 123,
"username": "hiro",
"first_name": "Hiro",
"last_name": "Protagonist",
"email": "hiro@protagonist.com",
"phone": "6420200200",
"is_admin": false,
"is_activated": true,
"is_deal_flow_accepted": false
},
"relationships": {
"domain_portfolio": {
"data": {
"type": "domain_portfolios",
"id": "456"
}
}
},
"links": {
"self": "https://api.flippa.com/v3/users/123"
}
}
This endpoint can be used to retrieve details of the User for which the provided access token is associated with.
If an access token that is not associated with a User is provided, the API will respond with 403 Forbidden.
HTTP Request
GET https://api.flippa.com/v3/users/identify
Retrieving a User
flippa.user(123).retrieve()
curl https://api.flippa.com/v3/users/123
{
"data": {
"type": "users",
"id": 123,
"username": "hiro",
"first_name": "Hiro",
"last_name": "Protagonist",
"is_admin": false,
"is_activated": true,
"is_deal_flow_accepted": false
},
"relationships": {
"domain_portfolio": {
"data": {
"type": "domain_portfolios",
"id": "456"
}
}
},
"links": {
"self": "https://api.flippa.com/v3/users/123"
}
}
Retrieves the details of a specific User using their unique ID.
HTTP Request
GET https://api.flippa.com/v3/users/123
Creating a User
flippa.users.create({
username: "hiro",
email: "hiro@metaverse.net",
password: "stephenson",
g_recaptcha_response: "abc123"
})
curl https://api.flippa.com/v3/users \
-d username=hiro \
-d email=hiro@metaverse.net \
-d password=stephenson \
-d g_recaptcha_response=abc123
{
"data": {
"type": "users",
"id": 123,
"username": "hiro",
"first_name": null,
"last_name": null,
"is_admin": false,
"is_activated": true,
"is_deal_flow_accepted": false
},
"links": {
"self": "https://api.flippa.com/v3/users/123"
}
}
Creates a new user with the given details.
The provided email address will be sent an email to verify the account.
HTTP Request
POST https://api.flippa.com/v3/users
Parameters
Parameter | Required | Description |
---|---|---|
username | yes | The username of the user to create. |
yes | The email address of the user to create. | |
password | yes | The password of the user to create. |
g_recaptcha_response | yes | A response token from the Google reCAPTCHA service. |
signup_source | no | Where the new user is signing up from. |
Relationships
Domain Portfolio data if the user has a Portfolio.
Relationship fields
domain_portfolio
Value | Type | Description |
---|---|---|
id | String | The id representation of the domain portfolio for user. |
Watched Items
Creating a Watched Item
flippa.user(123).createWatchedItem({item_id: 123, item_type: "listing"})
curl https://api.flippa.com/v3/users/123/watched-items \
-d item_type=listing \
-d item_id=456
{
"data": {
"type": "watched-items",
"id": "789",
"relationships": {
"watcher": {
"links": {
"self": "https://api.flippa.com/v3/users/123"
},
"data": {
"type": "users",
"id": "123"
}
},
"item": {
"links": {
"self": "https://api.flippa.com/v3/listings/456"
},
"data": {
"type": "listings",
"id": "456"
}
},
"links": {
"self": "https://api.flippa.com/v3/watched-items/789"
}
}
}
}
Adds the given item to the given user’s watchlist.
If the item is already being watched, this operation is a no-op.
HTTP Request
POST https://api.flippa.com/v3/users/123/watched-items
Parameters
Parameter | Description |
---|---|
item_type | The type of watched item to create. |
item_id | The ID of the item to watch. |
Deleting a Watched Item
flippa.user(123).delWatchedItem({item_id: 123, item_type: "listing"})
curl -XDELETE https://api.flippa.com/v3/users/123/watched-items
Deletes the Watched Item matching the given parameters.
Successful requests have no response body and will respond with a 204 No
Content
status.
HTTP Request
DELETE https://api.flippa.com/v3/users/123/watched-items
Parameters
Parameter | Description |
---|---|
item_type | The type of watched item to delete. |
item_id | The ID of the item to delete. |
Experiments
Retrieving an experiment
flippa.user(123).retrieveExperiment("excellent_experiment")
curl https://api.flippa.com/v3/users/123/experiments/excellent_experiment
{
"data": {
"type": "experiments",
"id": "excellent_experiment",
"attributes": {
"variation": "control"
}
}
}
Retrives the given experiment and variation name.
HTTP Request
GET https://api.flippa.com/v3/users/123/experiments/excellent_experiment