API Documentation - Fixido Developer Center

Fixido provides a REST based API to perform various tasks. Before you begin using the API, you must register an application to get your access key and secret key. You can create an application here.

Once you have created your application, the system automatically generates an access key and a secret key for you, which you can view on the same page. The system also automatically grants rights to a few essential methods such as creating, editing and listing leads. You can review your rights in the API Playground. You can create more applications with different roles.

Technical Information

With every request to the API, you must attach the access key and the secret key. And, based on the method, you may also have to add some more data. Since it's a REST based API, you can access it using any programming language which performs HTTP requests. The following parameters are mandatory in every GET/POST request:

Property	Data type	Description
`access_key`	string	The access key issued to you upon creating your application.
`access_secret`	string	The access secret issued to you upon creating your application.

The Fixido API provides the data in JSON format (JSONP is also supported). Responses for all the requests follow the same structure. The response object has the following properties:

status - boolean - Returns false whenever your request failed to complete.
error - array - List of errors which occurred while performing your request.
data - object - Actual data for your request.

Code Samples

You can find some code samples on our Github page.

Creates a new lead in the Fixido marketplace system. Make sure to provide as much information as possible to give the buyers a great lead. You need to be registered as a seller in Fixido in order to create a lead. If not, fill in the form in the Fixido dashboard Provided Leads page.

Guideline for creating Leads

Request:

POST http://fixido.com/api/leads/create/

POST parameters:

Property	Data type	Description	Default value	Required
`title`	string	Title of the lead		yes
`description`	string	Description of the lead		yes
`price`	float	Price of the lead	`0.0`	yes
`price_currency`	string	Currency of the `price` in question		yes
`budget`	float	The customer's budget	`0.0`
`budget_currency`	string	Currency of the `budget` in question
`sale`	integer	The number of times the same lead information can be sold. One sale means that one company will contact the consumer.	`0`	yes
`deal_starts`	datetime	Starting date of the lead. It should be in the format `YYYY-MM-DD hh:mm:ss`		yes
`deal_ends`	datetime	Ending date of the lead. It should be in the format `YYYY-MM-DD hh:mm:ss`		yes
`category_id`	integer	ID of the lead category. Categories can be listed with the Lead Categories API		yes
`keywords`	string	Comma separated keywords		yes
`generation_method`	string	Method of generation of the lead. Values can be `phone` or `online`.	`'online'`
`language`	string	Language of the lead. Format: ISO-639-1, two character language code.		yes
`pre_sold`	integer	Number of leads already sold before entering into Fixido	`0`	yes
`address_street`	string	Full street address of the consumer
`address_city`	string	Lead consumer city
`company_name`	string	Company name of the consumer/contact person
`consumer_first_name`	string	First name of the consumer/contact person		yes
`consumer_last_name`	string	Last name of the consumer/contact person		yes
`address_country`	string	Country of the consumer/contact person (three character ISO-3166-1 code)
`address_postal_code`	string	Postal/zip code of the consumer/contact person
`address_region`	string	Geographic region of the consumer/contact person
`consumer_email`	string	E-mail address of the consumer/contact person		yes
`generation_source`	string	Lead generation source
`consumer_preferred_method`	string	The way in which the lead consumer wishes to be contacted
`reference`	string	Your internal lead ID/reference
`status`	string	Status of the lead: `active`, `inactive`, or `test`	`'active'`	yes
`accept_campaign`	boolean	Indicates whether or not the lead may be used in a campaign	`true`
`set_auction`	boolean	Indicates whether this lead is an auction lead	`false`
`au_minimum_price`	float	Minimum price for lead during auction
`au_minutes_to_auction_start`	integer	Defines the time for running the auction, in minutes. Minimum `600`

Response:

{
    'status': true,
    'error': [],
    'data': GENERATED LEAD ID
}

Use Get Lead to return details for a specific lead. With Get Lead you can only return your provided and bought leads.

Request:

GET/POST http://fixido.com/api/leads/get/[LEAD_ID]/

Response:

{
    'status': true,
    'data': {
        'available': 2,
        'reference': '',
        'image': null,
        'generation_source': 'myleadprovider.com',
        'budget_currency': 'SEK',
        'consumer_id': 111111,
        'consumer_first_name': 'Sven',
        'keywords': '',
        'consumer_lastname': 'Svensson',
        'address_street': 'Storgatan 15',
        'id': 123456,
        'price_currency': 'SEK',
        'deal_ends': '2013-01-10T23:00:00Z',
        'title': 'Flytthjälp:Skärholmen : Skärholmen 2013-01-15',
        'address_region': '',
        'company_name': '',
        'generation_date': '2012-12-13T00:47:26Z',
        'price': 300,
        'status': 'active',
        'consumer_preferred_method': '',
        'description': '',
        'email_verified': false,
        'sold': 0,
        'reinquire': false,
        'consumer_phone_number': '',
        'phone_verified': false,
        'consumer_email': '',
        'deal_starts': '2012-12-11T23:00:00Z',
        'address_city': '',
        'Total': 2,
        'pre_sold': 0,
        'consumer_last_name': 'Svensson',
        'language': 'sv',
        'address_country': 'SE',
        'sale': 2,
        'generation_method': 'online',
        'address_postal_code': '',
        'budget': 0,
        'consumer_phno': '',
        'category_id': 13,
        'consumer': ''
    },
    'error': []
}

Use List Leads to return a list of leads where you are the seller. Returns an array of leads, in the same format as leads/get.

Request:

GET/POST http://fixido.com/api/leads/list/

Response:

{
    'status': true,
    'data': [
        {
            'available': 2,
            'reference': '',
            'image': null,
            'generation_source': 'myleadprovider.com',
            ...
        },
        ...
    ]
    'error': []
}

Use List Provided Leads to return a list of your provided leads. In most cases, this is the same list as the Leads List, only slower. The return format is also the same.

Request:

GET/POST http://fixido.com/api/leads_provided/list/

Use List Bought Leads to return a list of your bought leads. The return format is the same as for Leads List.

Request:

GET/POST http://fixido.com/api/leads_bought/list/

Use Update Lead to update your leads. You can only update data in your provided leads. Parameters are the same as for Create Lead.

Request:

POST http://fixido.com/api/leads/update/[LEAD_ID]/

Response:

{
    'status': true,
    'error': [],
    'data': LEAD ID
}

Use Delete Lead to delete your leads (or, to be precise, flag them as 'inactive'). You can only delete your provided leads.

Request:

GET/POST http://fixido.com/api/leads/delete/[LEAD_ID]/

{
    'status': true,
    'data': DELETED LEAD ID,
    'error': []
}

Use Buy Lead to purchase a lead from Fixido. You can buy any lead that is available in Fixido.

Request:

POST http://fixido.com/api/leads/buy/[LEAD_ID]/

POST parameters:

Property	Data type	Description	Default value	Required
`sale`	integer	Number of leads to purchase. This is not as yet implemented, and will always be 1.	`1`
`payment_mode`	string	Payment mode to use. This is not as yet implemented, and will always be 'account'.	`'account'`

Response:

{
    "status": "true",
    "data": "Order successful",
    "error": ""
}

Use List Filters to check the filters that are created by you.

Request:

GET http://fixido.com/api/filters/list/

GET parameters:

Property	Data type	Description	Default value	Required
`page`	integer	Specify the page number you need. Check the output to see how many pages exist.	`1`
`result_per_page`	integer	Number of filters to return.	`5`

Response:

{
    "status": true,
    "data": {
        "current_page": 1,
        "total_result": 426,
        "filters": [
            {
                "status": "active",
                "search": "målarfirma Danmark",
                "description": "",
                "created": "2013-04-08T13:05:29Z",
                "clon": null,
                "leadcount": 0,
                "crad": 0,
                "clat": null,
                "id": 45,
                "name": "målarfirma Danmark"
            },
            ...
        ]
    },
    "error": []
}

Use List Categories to get a list of all lead categories in the Fixido marketplace system. You may then use the category ID's when creating new leads.

Request:

GET http://fixido.com/api/categories/list/

GET parameters:

Property	Data type	Description	Default value
`language`	string	The language of your choice, in ISO-639-1 two characters language code format. Currently available are `en`, `sv`, and `de`.	`'en'`
`page`	integer	Specify the page number you need. Check the output to see how many pages exist.	`1`
`result_per_page`	integer	Number of categories to return.	`5`

Response:

{
    "status": true,
    "data": {
        "current_page": 1,
        "total_result": 21,
        "categories": [
            {
                "category": 3,
                "name": "Arts & Entertainment"
            },
            {
                "category": 24,
                "name": "Bank & Financial"
            },
            ...
        ]
    },
    "error": []
}

Use Search Detail to return details for a specific lead. If you bought the lead, you will see all locked consumer contact details. These are all the values with keys beginning with consumer_.

Request:

GET http://fixido.com/api/search/get/[LEAD_ID]/

Response:

{
    "status": true,
    "data": {
        "seller_name": "Some Seller",
        "consumer_id": 110616,
        "consumer_first_name": "Sven",
        "keywords": "",
        "total": 2,
        "address_country": "",
        "id": 122433,
        "price_currency": "SEK",
        "deal_ends": "2013-01-10T23:00:00Z",
        "title": "Flytthjälp:Skärholmen : Mörbulta 2013-01-15",
        "address_region": "",
        "generation_date": "2012-12-13T00:47:26Z",
        "available": 1,
        "ranking": 0,
        "description": "...",
        "price": 50,
        "reinquire": false,
        "consumer_phone_number": "123545",
        "phone_verified": false,
        "consumer_email": "sven.svensson@svensson.se",
        "deal_starts": "2012-12-11T23:00:00Z",
        "address_city": "Skärholmen",
        "consumer_last_name": "Svensson",
        "language": "sv",
        "created": "2017-05-26T12:48:13Z",
        "email_verified": false,
        "generation_method": "online",
        "address_postal_code": "121323",
        "category_id": 13
    },
    "error": []
}

Use Search List to get a list of leads. You specify search criteria and use pagination. The response is an array of leads, in the same format as Search Detail.

Request:

GET http://fixido.com/api/search/list/

GET parameters:

Property	Data type	Description	Default value
`q`	string	Search string. Specify any search words you need. Leave blank to get all leads.
`page`	integer	Specify the page number you need. Check the output to see how many pages exist.	`1`
`result_per_page`	integer	Number of leads to return.	`5`
`budget_start`	float	What the consumer wants to spend on the product/service; minimum.
`budget_end`	float	What the consumer wants to spend on the product/service; maximum.
`deal_start`	date	When the consumer interest starts. Format: YYYY-MM-DD.
`deal_end`	date	When the consumer interest ends. Format: YYYY-MM-DD.
`created_start`	date	When leads were created; minimum. Format: YYYY-MM-DD.
`created_end`	date	When leads were created; maximum. Format: YYYY-MM-DD.
`price_start`	float	Minimum price of the lead.
`price_end`	float	Maximum price of the lead.
`locations`	string	Location(s) of the consumer, comma separated.
`keywords`	string	Keyword(s) of the leads, comma separated.
`category`	integer	Category ID; see Categories List.
`lang`	string	Language(s) of the leads, comma separated. Format: ISO-639-1, two character language code.

Response:

{
    "status": true,
    "data": {
        "leads": [
            {
                "seller_name": "Some Seller",
                "consumer_id": 110616,
                ...
            },
            ...
        ],
        "query": "",
        "current_page": 1,
        "total_result": 22
    },
    "error": []
}

Gives you a list of your latest searches on Fixido, with the most recent search first.

Request:

GET http://fixido.com/api/recentsearch/list/

GET parameters:

Property	Data type	Description	Default value
`page`	integer	Specify the page number you need. Check the output to see how many pages exist.	`1`
`result_per_page`	integer	Number of searches to return.	`5`
`date_from`	date	Earliest search date to include. Format: YYYY-MM-DD.
`date_to`	date	Latest search date to include. Format: YYYY-MM-DD.

Response:

{
    "status": true,
    "data": {
        "current_page": 1,
        "recentsearch": [
            {
                "search": "putz",
                "id": 10588,
                "created": "2015-04-22T15:49:26Z"
            },
            {
                "search": "städning",
                "id": 10587,
                "created": "2015-04-22T15:49:11Z"
            },
            ...
        ],
        "total_result": 2000
    },
    "error": []
}

Returns a list of recent lead views by you, in descending chronological order. Please note that the created property contains the time when you last viewed the lead, not when the lead was created.

Request:

GET http://fixido.com/api/recentleads/list/

GET parameters:

Property	Data type	Description	Default value
`page`	integer	Specify the page number you need. Check the output to see how many pages exist.	`1`
`result_per_page`	integer	Number of views to return.	`5`
`date_from`	date	Earliest view date to include. Format: YYYY-MM-DD.
`date_to`	date	Latest view date to include. Format: YYYY-MM-DD.

Response:

{
    "status": true,
    "data": {
        "current_page": 1,
        "recentlead": [
            {
                "id": 198558,
                "lead_id": 11020,
                "lead_title": "Markarbeten:Östergötland uppdrag:Plattläggning",
                "created": "2017-05-31T14:52:36Z"
            },
            ...
        ],
        "total_result": 2000
    },
    "error": []
}

Returns a list of your lead sales, in reverse chronological order.

Request:

GET http://fixido.com/api/trades/list/

GET parameters:

Property	Data type	Description	Default value
`page`	integer	Specify the page number you need. Check the output to see how many pages exist.	`1`
`result_per_page`	integer	Number of trades to return.	`5`
`date_from`	date	Earliest trade date to include. Format: YYYY-MM-DD.
`date_to`	date	Latest trade date to include. Format: YYYY-MM-DD.
`lead_id`	integer	Only return trades for a specific lead.

Response:

{
    "status": true,
    "data": {
        "trades": [
            {
                "price_currency": "SEK",
                "lead_id": 122433,
                "title": "Flytthjälp:Skärholmen : Skärholmen 2013-01-15",
                "commission_total": "15",
                "price": "50",
                "transaction_date": "2017-06-01T11:11:19Z",
                "seller_sales_total": "35",
                "commission_percentage": 30,
                "seller_sales_transaction_id": "SS20001785",
                "transaction_id": "AO20001774",
                "quantity": 1
            },
            ...
        ],
        "total_result": 581,
        "current_page": 1
    },
    "error": []
}

Returns a list of your transactions. A Transaction literally represents one transferral of money, and consists of one or more Trades.

Request:

GET http://fixido.com/api/transactions/list/

GET parameters:

Property	Data type	Description	Default value
`page`	integer	Specify the page number you need. Check the output to see how many pages exist.	`1`
`result_per_page`	integer	Number of trades to return.	`5`
`date_from`	date	Earliest trade date to include. Format: YYYY-MM-DD.
`date_to`	date	Latest trade date to include. Format: YYYY-MM-DD.
`transaction_type`	string	Type of transaction. Valid choices: `order`, `deposit`, `payout`, `voucher`, `invite`, `sales`, `commission`, `kickback`, `signupbonus`, `refund`, `credit`, `invoice`, `expired`.
`transaction_id`	string	Use this if you just want info about a specific transaction.

Response:

{
    "status": true,
    "data": {
        "current_page": 1,
        "total_result": 100,
        "Transactions": [
            {
                "reference": "FC20001785",
                "created": "2017-06-01T11:11:19Z",
                "order_id": 884,
                "transaction_type": "commission",
                "actor_key": "5761",
                "transaction_date": "2017-06-01T11:11:19Z",
                "transaction_id": 2907
            },
            {
                "reference": "AO20001774",
                "created": "2017-06-01T11:11:18Z",
                "order_id": 884,
                "transaction_type": "order",
                "actor_key": "5761",
                "transaction_date": "2017-06-01T11:11:18Z",
                "transaction_id": 2906
            },
            ...
        ]
    },
    "error": []
}

Overview API v2.0

Technical Information

Code Samples

Create Lead

Get Lead - get your lead details

List Leads

List Provided Leads

List Bought Leads

Update Lead

Delete Lead

Buy Lead

List Filters

List Categories

Search Detail - Get details of a searched lead

Search List - Search for leads

List Recent Searches

List Recently Viewed Leads

List Trades

List Transactions

Bid amount: 0 USD

Make this bid as your permanent bid on all future matching leads

TERMS OF SERVICE  THE SHORT VERSION

ABOUT FIXIDO AND OUR SERVICE:

ABOUT BUYERS OF LEADS:

ABOUT SELLERS OF LEADS:

TERMS OF SERVICEVERSION 4.0, 2014-06-24

RELIANCE ON INFORMATION POSTED & DISCLAIMER

INFORMATION ABOUT US

PARTICIPATION IN SERVICE

INTRODUCTION TO A LEAD

PAYMENT

USE OF LEADS AND INFORMATION ABOUT LEADS

CONFIDENTIALITY OF LEAD DATA

OUR SITE CHANGES REGULARLY

OUR LIABILITY

REPORT AND COMPLAIN

INFORMATION ABOUT YOU AND YOUR VISITS TO OUR SITE

VIRUSES, HACKING AND OTHER OFFENCES

CHANGE OF SERVICE

UPGRADES, SUPPORT AND NOTICES

JURISDICTION AND APPLICABLE LAW

TRADE MARKS

VARIATIONS

YOUR CONCERNS

TERMS OF SERVICE THE SHORT VERSION