Get Started

The API is meant for users who wish to pull auction data to their platform for displaying active auctions on their own websites/applications or to pull historical data.

Get started by requested an API Username and Password to connect to iBidAPI.

Requests are cached and we limit calls to once an hour. If you have a scheduled preference we can accommodate. You also have the ability to clear our cache and retry a request from within your API dashboard.

Example

Please click this demo page and input your details

Class Overview

Create a class object by passing endpoint, userName, apiKey, local

$wrapper = new ApiIbid4Storage(
'https://api.ibid4storage.com//api/v1/session/login',
$userName,
$apiKey,
'en'
);

Then you can fetch units by passing parameters to the fetchAllUnits function.

$result = $wrapper->fetchAllUnits($start,$end,$location_id);
$units = json_decode($result);

You can also fetch all locations information by fetchAllLocationsInfo function.

$result = $wrapper->fetchAllLocationsInfo();
$locations_info = json_decode($result);

API Library

Click here to download the Api library .

fetchAllUnits

fetchAllUnits is used to retrieve the all units for a particular company and location between two dates given.

Parameters:

Order	Type	Description
1	Date (format="yyyy-mm-dd")	StartDate: Pull auctions which have after Auction end date to StartDate given.
2	Date (format="yyyy-mm-dd")	EndDate: Pull auctions which have before Auction end date to EndDate given.
3	String	LocationUniqueID: Pull auctions to the specific LocationUniqueID given.

Returns:

It will return two data objects, result and data.

Result Object:

Order	Type	Description
1	Boolean	True - Success

Data Object:

Order	Type	Name	Description
1	String	unitID	Unit Unique ID
2	String	locationUniqueID	Location Unique ID
3	Date Time	creationDate	Auction creation date time
4	Date Time	modificationDate	Auction modification date time
5	Integer	unitStatus	Status of Auction (0,1,3,5,10) 5 closed, 0 not closed
6	String	unitDescription	Some description about Auction
7	String	size	Size of Auction
8	String	feature	Feature of Auction
9	String	video	Youtube video link
10	Integer	startingPrice	Starting price of auction
11	Integer	currentPrice	Current price of auction
12	DateTime	startDate	Start date of auction
13	DateTime	startDateUTC	UTC start date of auction
14	DateTime	endDate	End date of auction
15	DateTime	endDateUTC	UTC end date of auction
16	Integer	buyItNow	Buy It Now (1-yes, 2-no)
17	Integer	buyItNowPrice	Price for Buy It Now auction
18	Integer	unitBidCount	Total on of bids on auction
19	string	image	Complete path of images comma sperated
20	string	thumbImage	Complete path of tumbnail images comma sperated
21	string	sellerName	Seller Name
22	string	sellerUnitNumber	Seller Unit Number
23	string	sellerDescription	Seller description
24	string	sellerAddress	Seller address
25	string	sellerPostal	Seller postal code
26	string	sellerCity	Seller city
27	string	sellerState	Seller state
28	string	sellerPhone	Seller phone number
29	string	sellerLatitude	Seller latitude
30	string	sellerLongitude	Seller longitude
31	string	sellerTimezone	Seller timezone
32	string	status	Auction status (Live, Not Live, Removed, Sold, Ended)

On failure:

Order	Type	Description
1	Boolean	False - Failed
2	Object	Error object with error_id and error_message

fetchAllLocationsInfo

Used to retrieve details of all the locations for a particular company. (Please note no parameter required)