GunBroker.com Auctions Web Service

The GunBroker.com SOAP API will be deprecated.  Please start using our REST API for your applications.

Click here for a complete list of operations.

Login

Test Login to the GunBroker Web Service / verify credentials

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
DevKey:
AppKey:

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /AuctionService.asmx HTTP/1.1
Host: apiv2.gunbroker.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "GunBrokerAPI_V2/Login"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <Login xmlns="GunBrokerAPI_V2">
      <DevKey>string</DevKey>
      <AppKey>string</AppKey>
    </Login>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <LoginResponse xmlns="GunBrokerAPI_V2">
      <LoginResult>
        <Timestamp>dateTime</Timestamp>
        <Ack>Success or Failure or Warning</Ack>
        <Errors>
          <ShortMessage>string</ShortMessage>
          <LongMessage>string</LongMessage>
          <ErrorCode>string</ErrorCode>
        </Errors>
        <User>
          <HadTransactionWithUser>boolean</HadTransactionWithUser>
          <UserID>int</UserID>
          <Status>int</Status>
          <UserName>string</UserName>
          <FeedbackScore>int</FeedbackScore>
          <FeedbackRating>decimal</FeedbackRating>
          <FeedbackDisplay>string</FeedbackDisplay>
          <RegistrationDate>dateTime</RegistrationDate>
          <Email>string</Email>
          <HomePhone>string</HomePhone>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <Suffix>string</Suffix>
          <RegistrationAddress>string</RegistrationAddress>
          <ShippingAddress>string</ShippingAddress>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <City>string</City>
          <State>string</State>
          <PostalCode>string</PostalCode>
          <CountryCode>string</CountryCode>
        </User>
      </LoginResult>
    </LoginResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /AuctionService.asmx HTTP/1.1
Host: apiv2.gunbroker.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <Login xmlns="GunBrokerAPI_V2">
      <DevKey>string</DevKey>
      <AppKey>string</AppKey>
    </Login>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <LoginResponse xmlns="GunBrokerAPI_V2">
      <LoginResult>
        <Timestamp>dateTime</Timestamp>
        <Ack>Success or Failure or Warning</Ack>
        <Errors>
          <ShortMessage>string</ShortMessage>
          <LongMessage>string</LongMessage>
          <ErrorCode>string</ErrorCode>
        </Errors>
        <User>
          <HadTransactionWithUser>boolean</HadTransactionWithUser>
          <UserID>int</UserID>
          <Status>int</Status>
          <UserName>string</UserName>
          <FeedbackScore>int</FeedbackScore>
          <FeedbackRating>decimal</FeedbackRating>
          <FeedbackDisplay>string</FeedbackDisplay>
          <RegistrationDate>dateTime</RegistrationDate>
          <Email>string</Email>
          <HomePhone>string</HomePhone>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <Suffix>string</Suffix>
          <RegistrationAddress>string</RegistrationAddress>
          <ShippingAddress>string</ShippingAddress>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <City>string</City>
          <State>string</State>
          <PostalCode>string</PostalCode>
          <CountryCode>string</CountryCode>
        </User>
      </LoginResult>
    </LoginResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /AuctionService.asmx/Login?DevKey=string&AppKey=string HTTP/1.1
Host: apiv2.gunbroker.com
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<LoginResult xmlns="GunBrokerAPI_V2">
  <Timestamp>dateTime</Timestamp>
  <Ack>Success or Failure or Warning</Ack>
  <Errors>
    <ShortMessage>string</ShortMessage>
    <LongMessage>string</LongMessage>
    <ErrorCode>string</ErrorCode>
  </Errors>
  <User>
    <HadTransactionWithUser>boolean</HadTransactionWithUser>
    <UserID>int</UserID>
    <Status>int</Status>
    <UserName>string</UserName>
    <FeedbackScore>int</FeedbackScore>
    <FeedbackRating>decimal</FeedbackRating>
    <FeedbackDisplay>string</FeedbackDisplay>
    <RegistrationDate>dateTime</RegistrationDate>
    <Email>string</Email>
    <HomePhone>string</HomePhone>
    <FirstName>string</FirstName>
    <LastName>string</LastName>
    <Suffix>string</Suffix>
    <RegistrationAddress>string</RegistrationAddress>
    <ShippingAddress>string</ShippingAddress>
    <Address1>string</Address1>
    <Address2>string</Address2>
    <City>string</City>
    <State>string</State>
    <PostalCode>string</PostalCode>
    <CountryCode>string</CountryCode>
  </User>
</LoginResult>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /AuctionService.asmx/Login HTTP/1.1
Host: apiv2.gunbroker.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

DevKey=string&AppKey=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<LoginResult xmlns="GunBrokerAPI_V2">
  <Timestamp>dateTime</Timestamp>
  <Ack>Success or Failure or Warning</Ack>
  <Errors>
    <ShortMessage>string</ShortMessage>
    <LongMessage>string</LongMessage>
    <ErrorCode>string</ErrorCode>
  </Errors>
  <User>
    <HadTransactionWithUser>boolean</HadTransactionWithUser>
    <UserID>int</UserID>
    <Status>int</Status>
    <UserName>string</UserName>
    <FeedbackScore>int</FeedbackScore>
    <FeedbackRating>decimal</FeedbackRating>
    <FeedbackDisplay>string</FeedbackDisplay>
    <RegistrationDate>dateTime</RegistrationDate>
    <Email>string</Email>
    <HomePhone>string</HomePhone>
    <FirstName>string</FirstName>
    <LastName>string</LastName>
    <Suffix>string</Suffix>
    <RegistrationAddress>string</RegistrationAddress>
    <ShippingAddress>string</ShippingAddress>
    <Address1>string</Address1>
    <Address2>string</Address2>
    <City>string</City>
    <State>string</State>
    <PostalCode>string</PostalCode>
    <CountryCode>string</CountryCode>
  </User>
</LoginResult>