GovDeals API

Accounts

Format: JSON
HTTP Method: GET
URL(s)
    Specific: https://stage-sam.lqdt1.com/v3/getaccounts.cfm?token=(APIKEY)&accntID=(ACCTID)&format=json
Requires Authentication: Yes
HTTP Headers:
    Accept: application/json
Return Values:
    HTTP Status: 200 OK
    JSON Struct
Example Return(s):
     { "Accounts": { "RowCount": "1", "FieldNames": "Column Name, Column Name, ...", "Row": [ {"name": "Column Name", "value": "Value"}, ... ] } }

Format: XML
HTTP Method: GET
URL(s)
    Specific: https://stage-sam.lqdt1.com/v3/getaccounts.cfm?token=(APIKEY)&accntID=(ACCTID)&format=xml
Requires Authentication: Yes
HTTP Headers:
    Accept: application/xml
Return Values:
    HTTP Status: 200 OK
    XML Struct
Example Return(s):
     <Accounts RowCount="1" FieldNames="Column Name,Column Name,..."> <Row> <Column Name>Data</Column Name> <Column Name>Data</Column Name>...</Row> </Accounts>

Departments

Format: JSON
HTTP Method: GET
URL(s)
    All: https://stage-sam.lqdt1.com/v3/getdepartments.cfm?token=(APIKEY)&accntID=(ACCTID)&deptID=&format=json
    Specific: https://stage-sam.lqdt1.com/v3/getdepartments.cfm?token=(APIKEY)&accntID=(ACCTID)&deptID=(DEPTID)&format=json
Requires Authentication: Yes
HTTP Headers:
    Accept: application/json
Return Values:
    HTTP Status: 200 OK
    JSON Struct
Example Return(s):
    All: { "Departments": { "RowCount": "1", "FieldNames": "Column Name, Column Name, ...", "Row": [ {"name": "Column Name", "value": "Value"}, ... ] } }

Format: XML
HTTP Method: GET
URL(s)
    All: https://stage-sam.lqdt1.com/v3/getdepartments.cfm?token=(APIKEY)&accntID=(ACCTID)&deptID=&format=xml
    Specific: https://stage-sam.lqdt1.com/v3/getdepartments.cfm?token=(APIKEY)&accntID=(ACCTID)&deptID=(DEPTID)&format=xml
Requires Authentication: Yes
HTTP Headers:
    Accept: application/xml
Return Values:
    HTTP Status: 200 OK
    XML Struct
Example Return(s):
    All: <Departments RowCount="1" FieldNames="Column Name,Column Name,..."> <Row> <Column Name>Data</Column Name> <Column Name>Data</Column Name>...</Row> </Departments>

Assets

Format: JSON
HTTP Method: GET
URL(s)
    Specific: https://stage-sam.lqdt1.com/v3/getassets.cfm?token=(APIKEY)&accntID=(ACCTID)&assetID=(ASSETID)&inventoryID=(INVENTORYID)&format=json
Requires Authentication: Yes
HTTP Headers:
    Accept: application/json
Return Values:
    HTTP Status: 200 OK
    JSON Struct
Example Return(s):
     { "Assets": { "RowCount": "1", "FieldNames": "Column Name, Column Name, ...", "Row": [ {"name": "Column Name", "value": "Value"}, ... ] } }

Format: XML
HTTP Method: GET
URL(s)
    Specific: https://stage-sam.lqdt1.com/v3/getassets.cfm?token=(APIKEY)&accntID=(ACCTID)&assetID=(ASSETID)&inventoryID=(INVENTORYID)&format=xml
Requires Authentication: Yes
HTTP Headers:
    Accept: application/xml
Return Values:
    HTTP Status: 200 OK
    XML Struct
Example Return(s):
     <Assets RowCount="1" FieldNames="Column Name,Column Name,..."> <Row> <Column Name>Data</Column Name> <Column Name>Data</Column Name>...</Row> </Assets>

HTTP Method: POST
URL(s)
    All: https://stage-sam.lqdt1.com/v3/asset_import.cfm?token=(APIKEY)&accntID=(ACCTID)
Requires Authentication: Yes
HTTP Headers:
    Accept: application/xml
POST HTTP Content Type:
    application/xml
POST HTTP Content:
    XML Struct
Example POST Content: (Asset Import)

Locations

Format: JSON
HTTP Method: GET
URL(s)
    All: https://stage-sam.lqdt1.com/v3/getlocations.cfm?token=(APIKEY)&accntID=(ACCTID)&locationID=&zipcode=&state=&city=&country=&format=json
    Zip Code: https://stage-sam.lqdt1.com/v3/getlocations.cfm?token=(APIKEY)&accntID=(ACCTID)&locationID=&zipcode=(ZIPCODE)&state=(STATE)&city=(CITY)&country=(COUNTRY)&format=json
Location ID: https://stage-sam.lqdt1.com/v3/getlocations.cfm?token=(APIKEY)&accntID=(ACCTID)&locationID=(ACCTID)&zipcode=&state=&city=&country=&format=json
Requires Authentication: Yes
HTTP Headers:
    Accept: application/json
Return Values:
    HTTP Status: 200 OK
    JSON Struct
Example Return(s):
    All: { "Locations": { "RowCount": "1", "FieldNames": "Column Name, Column Name, ...", "Row": [ {"name": "Column Name", "value": "Value"}, ... ] } }

Format: XML
HTTP Method: GET
URL(s)
    All: https://stage-sam.lqdt1.com/v3/getlocations.cfm?token=(APIKEY)&accntID=(ACCTID)&locationID=&zipcode=&state=&city=&country=&format=xml
    Zip Code: https://stage-sam.lqdt1.com/v3/getlocations.cfm?token=(APIKEY)&accntID=(ACCTID)&locationID=&zipcode=(ZIPCODE)&state=(STATE)&city=(CITY)&country=(COUNTRY)&format=xml
Location ID: https://stage-sam.lqdt1.com/v3/getlocations.cfm?token=(APIKEY)&accntID=(ACCTID)&locationID=(ACCTID)&zipcode=&state=&city=&country=&format=xml
Requires Authentication: Yes
HTTP Headers:
    Accept: application/xml
Return Values:
    HTTP Status: 200 OK
    XML Struct
Example Return(s):
    All: <Locations RowCount="1" FieldNames="Column Name, Column Name,..."> <Row> <Column Name>Data</Column Name> <Column Name>Data</Column Name>...</Row> </Locations>

Auctions

Format: JSON
HTTP Method: GET
URL(s)
    Specific: https://stage-sam.lqdt1.com/v3/getauctions.cfm?token=(APIKEY)&accntID=(ACCTID)&assetID=(ASSETID)&auctionID=(AUCTIONID)&format=json
Requires Authentication: Yes
HTTP Headers:
    Accept: application/json
Return Values:
    HTTP Status: 200 OK
    JSON Struct
Example Return(s):
     { "Auctions": { "RowCount": "1", "FieldNames": "Column Name, Column Name, ...", "Row": [ {"name": "Column Name", "value": "Value"}, ... ] } }

Format: XML
HTTP Method: GET
URL(s)
    Specific: https://stage-sam.lqdt1.com/v3/getauctions.cfm?token=(APIKEY)&accntID=(ACCTID)&assetID=(ASSETID)&auctionID=(AUCTIONID)&format=xml
Requires Authentication: Yes
HTTP Headers:
    Accept: application/xml
Return Values:
    HTTP Status: 200 OK
    XML Struct
Example Return(s):
     <Auctions RowCount="1" FieldNames="Column Name, Column Name,..."> <Row> <Column Name>Data</Column Name> <Column Name>Data</Column Name>...</Row> </Auctions>

HTTP Method: GET
URL(s)
    Specific: https://stage-sam.lqdt1.com/v3/saleupdate.cfm?token=(APIKEY)&accntID=(AUCTIONID)&assetid=(ASSETID)&paid=(BOOLEAN)&pickedup=(BOOLEAN)
Requires Authentication: Yes
HTTP Headers:
    Accept: application/xml
Return Values:
    HTTP Status: 200 OK

HTTP Method: POST
URL(s)
    All: https://stage-sam.lqdt1.com/v3/auction_import.cfm?token=(APIKEY)&accntID=(AUCTIONID)
Requires Authentication: Yes
HTTP Headers:
    Accept: application/xml
POST HTTP Content Type:
    application/xml
POST HTTP Content:
    XML Struct
Example POST Content: (Auction Import)

Sold

The user has the ability to search sold items based on a date range, by inventory ID, or by Asset ID.

Date Range --- for each format:
   START-DATE needs to be in the following format: 11/30/15
   END-DATE needs to be in the following format: 12/31/15
   Search range must be less than 1 year.
Inventory ID
   Search based on inventory ID for the asset.
Asset ID
   Search based on asset ID for the asset.
HTTP Method: GET
URL(s)

    Date Range: https://stage-sam.lqdt1.com/v3/getsold.cfm?token=(APIKEY)&accntID=(ACCTID)&assetID=(ASSETID)&startdate=(START-DATE)&enddate=(END-DATE)&format=json
    Inventory ID: https://stage-sam.lqdt1.com/v3/getsold.cfm?token=(APIKEY)&accntID=(ACCTID)&inventoryID=(INVENTORYID)&format=json
    Asset ID: https://stage-sam.lqdt1.com/v3/getsold.cfm?token=(APIKEY)&accntID=(ACCTID)&assetid=(ASSETID)&format=json
Requires Authentication: Yes
HTTP Headers:
    Accept: application/json
Return Values:
    HTTP Status: 200 OK
    JSON Struct
Example Return(s):
     { "Sold": { "RowCount": "1", "FieldNames": "Column Name, Column Name, ...", "Row": [ {"name": "Column Name", "value": "Value"}, ... ] } }

Format: XML
HTTP Method: GET
URL(s)
    Date Range: https://stage-sam.lqdt1.com/v3/getsold.cfm?token=(APIKEY)&accntID=(ACCTID)&assetID=(ASSETID)&startdate=(START-DATE)&enddate=(END-DATE)&format=xml
    Inventory ID: https://stage-sam.lqdt1.com/v3/getsold.cfm?token=(APIKEY)&accntID=(ACCTID)&inventoryID=(INVENTORYID)&format=xml
    Asset ID: https://stage-sam.lqdt1.com/v3/getsold.cfm?token=(APIKEY)&accntID=(ACCTID)&assetID=(ASSETID)&format=xml
Requires Authentication: Yes
HTTP Headers:
    Accept: application/xml
Return Values:
    HTTP Status: 200 OK
    XML Struct
Example Return(s):
     <Sold RowCount="1" FieldNames="Column Name, Column Name,..."> <Row> <Column Name>Data</Column Name> <Column Name>Data</Column Name>...</Row> </Sold>

POC

Format: JSON
HTTP Method: GET
URL(s)
     All: https://stage-sam.lqdt1.com/v3/getpoc.cfm?token=(APIKEY)&accntID=(ACCTID)&format=json
Requires Authentication: Yes
HTTP Headers:
    Accept: application/json
Return Values:
    HTTP Status: 200 OK
    JSON Struct
Example Return(s):
    All: { "Accounts": { "RowCount": "1", "FieldNames": "Column Name, Column Name, ...", "Row": [ {"name": "Column Name", "value": "Value"}, ... ] } }

Format: XML
HTTP Method: GET
URL(s)
     All: https://stage-sam.lqdt1.com/v3/getpoc.cfm?token=(APIKEY)&accntID=(ACCTID)&format=xml
Requires Authentication: Yes
HTTP Headers:
    Accept: application/xml
Return Values:
    HTTP Status: 200 OK
    XML Struct
Example Return(s):
    All: <Accounts RowCount="1" FieldNames="Column Name,Column Name,..."> <Row> <Column Name>Data</Column Name> <Column Name>Data</Column Name>...</Row> </Accounts>

Tiers

Format: JSON
HTTP Method: GET
URL(s)
     All: https://stage-sam.lqdt1.com/v3/getTiers.cfm?token=(APIKEY)&accntID=(ACCTID)&format=json
Requires Authentication: Yes
HTTP Headers:
    Accept: application/json
Return Values:
    HTTP Status: 200 OK
    JSON Struct
Example Return(s):
    All: { "Accounts": { "RowCount": "1", "FieldNames": "Column Name, Column Name, ...", "Row": [ {"name": "Column Name", "value": "Value"}, ... ] } }

Format: XML
HTTP Method: GET
URL(s)
     All: https://stage-sam.lqdt1.com/v3/getTiers.cfm?token=(APIKEY)&accntID=(ACCTID)&format=xml
Requires Authentication: Yes
HTTP Headers:
    Accept: application/xml
Return Values:
    HTTP Status: 200 OK
    XML Struct
Example Return(s):
    All: <Accounts RowCount="1" FieldNames="Column Name,Column Name,..."> <Row> <Column Name>Data</Column Name> <Column Name>Data</Column Name>...</Row> </Accounts>

Current Bid

No Bids
Return No Bid. Add &nobids=1 to the query string.

Format: JSON
HTTP Method: GET
URL(s)
     All: https://stage-sam.lqdt1.com/v3/getCurrentBid.cfm?token=(APIKEY)&accntID=(ACCTID)&format=json
Requires Authentication: Yes
HTTP Headers:
    Accept: application/json
Return Values:
    HTTP Status: 200 OK
    JSON Struct
Example Return(s):
    All: { "Accounts": { "RowCount": "1", "FieldNames": "Column Name, Column Name, ...", "Row": [ {"name": "Column Name", "value": "Value"}, ... ] } }

Format: XML
HTTP Method: GET
URL(s)
     All: https://stage-sam.lqdt1.com/v3/getCurrentBid.cfm?token=(APIKEY)&accntID=(ACCTID)&format=xml
Requires Authentication: Yes
HTTP Headers:
    Accept: application/xml
Return Values:
    HTTP Status: 200 OK
    XML Struct
Example Return(s):
    All: <Accounts RowCount="1" FieldNames="Column Name,Column Name,..."> <Row> <Column Name>Data</Column Name> <Column Name>Data</Column Name>...</Row> </Accounts>

Asset Status

The user has the ability to search asset information based on a date range, by status of asset or both.

Date Range --- for each format:
   START-DATE needs to be in the following format: 11/30/15
   END-DATE needs to be in the following format: 12/31/15
   Search range must be less than 1 year.
   If dates are not included default will be the past twelve months.
Status
   Status of asset. Example: STA, SOA, RFA
   If status is not included default to the status of 'all'.
HTTP Method: GET
URL(s)

    Date Range: https://stage-sam.lqdt1.com/v3/getAssetStatus.cfm?token=(APIKEY)&accntID=(ACCTID)&startdate=(START-DATE)&enddate=(END-DATE)&format=json
    Status: https://stage-sam.lqdt1.com/v3/getAssetStatus.cfm?token=(APIKEY)&accntID=(ACCTID)&status=(STATUS)&format=json
    Both: https://stage-sam.lqdt1.com/v3/getAssetStatus.cfm?token=(APIKEY)&accntID=(ACCTID)&startdate=(START-DATE)&enddate=(END-DATE)&status=(STATUS)&format=json
Requires Authentication: Yes
HTTP Headers:
    Accept: application/json
Return Values:
    HTTP Status: 200 OK
    JSON Struct
Example Return(s):
     { "Accounts": { "RowCount": "1", "FieldNames": "Column Name, Column Name, ...", "Row": [ {"name": "Column Name", "value": "Value"}, ... ] } }

Format: XML
HTTP Method: GET
URL(s)
    Date Range: https://stage-sam.lqdt1.com/v3/getAssetStatus.cfm?token=(APIKEY)&accntID=(ACCTID)&startdate=(START-DATE)&enddate=(END-DATE)&format=xml
    Status: https://stage-sam.lqdt1.com/v3/getAssetStatus.cfm?token=(APIKEY)&accntID=(ACCTID)&status=(STATUS)&format=xml
    Both: https://stage-sam.lqdt1.com/v3/getAssetStatus.cfm?token=(APIKEY)&accntID=(ACCTID)&startdate=(START-DATE)&enddate=(END-DATE)&status=(STATUS)&format=xml
Requires Authentication: Yes
HTTP Headers:
    Accept: application/xml
Return Values:
    HTTP Status: 200 OK
    XML Struct
Example Return(s):
     <Accounts RowCount="1" FieldNames="Column Name, Column Name,..."> <Row> <Column Name>Data</Column Name> <Column Name>Data</Column Name>...</Row> </Accounts>