github.com/vmpartner/bitmex@v1.1.0/swagger/api_response.go (about)

     1  /* 
     2   * BitMEX API
     3   *
     4   * ## REST API for the BitMEX Trading Platform  [View Changelog](/app/apiChangelog)    #### Getting Started   ##### Fetching Data  All REST endpoints are documented below. You can try out any query right from this interface.  Most table queries accept `count`, `start`, and `reverse` params. Set `reverse=true` to get rows newest-first.  Additional documentation regarding filters, timestamps, and authentication is available in [the main API documentation](https://www.bitmex.com/app/restAPI).  *All* table data is available via the [Websocket](/app/wsAPI). We highly recommend using the socket if you want to have the quickest possible data without being subject to ratelimits.  ##### Return Types  By default, all data is returned as JSON. Send `?_format=csv` to get CSV data or `?_format=xml` to get XML data.  ##### Trade Data Queries  *This is only a small subset of what is available, to get you started.*  Fill in the parameters and click the `Try it out!` button to try any of these queries.  * [Pricing Data](#!/Quote/Quote_get)  * [Trade Data](#!/Trade/Trade_get)  * [OrderBook Data](#!/OrderBook/OrderBook_getL2)  * [Settlement Data](#!/Settlement/Settlement_get)  * [Exchange Statistics](#!/Stats/Stats_history)  Every function of the BitMEX.com platform is exposed here and documented. Many more functions are available.  ##### Swagger Specification  [⇩ Download Swagger JSON](swagger.json)    ## All API Endpoints  Click to expand a section. 
     5   *
     6   * OpenAPI spec version: 1.2.0
     7   * Contact: support@bitmex.com
     8   * Generated by: https://github.com/swagger-api/swagger-codegen.git
     9   */
    10  
    11  package swagger
    12  
    13  import (
    14  	"net/http"
    15  )
    16  
    17  type APIResponse struct {
    18  	*http.Response `json:"-"`
    19  	Message string `json:"message,omitempty"`
    20  	// Operation is the name of the swagger operation.
    21  	Operation string `json:"operation,omitempty"`
    22  	// RequestURL is the request URL. This value is always available, even if the
    23  	// embedded *http.Response is nil.
    24  	RequestURL string `json:"url,omitempty"`
    25  	// Method is the HTTP method used for the request.  This value is always
    26  	// available, even if the embedded *http.Response is nil.
    27  	Method string `json:"method,omitempty"`
    28  	// Payload holds the contents of the response body (which may be nil or empty).
    29  	// This is provided here as the raw response.Body() reader will have already
    30  	// been drained.
    31  	Payload []byte `json:"-"`
    32  }
    33  
    34  func NewAPIResponse(r *http.Response) *APIResponse {
    35  
    36  	response := &APIResponse{Response: r}
    37  	return response
    38  }
    39  
    40  func NewAPIResponseWithError(errorMessage string) *APIResponse {
    41  
    42  	response := &APIResponse{Message: errorMessage}
    43  	return response
    44  }