Toggle navigation
FWS API Documentation
Overview
API Connection
Obtaining API Keys
PHP cURL Example
Request Headers
Searching Data
User Records
Authenticating a User
Registering A User
Retrieve User by ID
Updating User Data
Forgot Password Reset - Step 1
Forgot Password Reset - Step 2
Obtaining User Bidder Types
Submit a User Keyword Alert
Update a User Keyword Alert
Delete a User Keyword Alert
Retreive a User Keyword Alert List
Department Records
Obtaining a Department List
Retrieving a Particular Department
Retrieving a Particular Department By Slug
Category Records
Obtaining a Category List
Retrieving a Particular Category
Auctions
Obtaining Upcoming Auctions
Obtaining an Auction List
Obtaining Past Auctions
Retrieving a Particular Auction
Retrieving a Particular Auction by Slug
Registering For An Auction
Retrieve a Price List PDF
Items
Obtaining an Item List
Retrieving a Particular Item
Get Item Images
Retrieving a Particular Item by Item Slug
Follow an Item
Unfollow an Item
Obtaining a Followed Item List
Obtaining a Related Item List
Submit an Item Inquiry
Get Item List Bid Data
Reply to an Item Inquiry
Retrieve an Item Inquiry
Retrieve an Inquiry List
Submit an Item Offer
Obtain an Item Images List
Placing Bids
Place a Bid
Submit a Purchase Request
Submit a Phone Bid Registration
Delete a Phone Bid Registration
Retrieve a Phone Bid Registration
Submit a Request to Bid
My Account Data
Obtaining a List of a user's bid activity
Retrieve Saved Billing Data
Add New Credit Card
Update A Credit Card
Retrieve a Credit Card
Delete a Credit Card
Add a New Bank Account
Update a Bank Account
Delete a Bank Account
Retrieve a Bank Account
Mailing List
Obtaining the Mailing Lists
Miscellaneous Functions
Obtaining a Country List
Retrieve a Contract
Submit a Contract Signature
Submit a Consignment Request
Obtaining an Office List
Obtain a User's Invoice List
Retrieve an Invoice PDF
Obtain a User's File List
Obtaining an Occupation List
Retreive a Terms & Condition List
Retreive Individual Terms & Conditions
Connecting to the FWS API
Below is a list of pages and examples to help you connect to the FWS API.
Obtaining API Keys
PHP cURL Example
Request Headers