GET /instruments/traits-with-variance
List the distinict values possible for each trait for instruments matching the filters.

You must provide a brand or brand_id and a model or model_id to retrieve possible traits. Ideally, your application should fetch /traits-with-variance once the user has selected a brand, model and/or submodel. If you are using admin credentials to access the API you may omit these parameters but you should consider caching the results within your application.

By default, this API returns a set of possibilities for every trait. If you only need information about one trait, or a handful of traits, use the only parameter to improve performance (ex: ?only=fingerboard_inlay,truss_rod)

Supported Formats

json

Errors

400 The request was unacceptable, often due to missing a required parameter.

Examples

curl -X GET -H "Authorization: XXXXX" "https://api.axefax.com/instruments/traits-with-variance?brand=fender&model=Stratocaster&serial_number=4900"

{
  "number_of_strings": [
    {
      "id": 1954,
      "value": "6",
      "description": "None provided."
    }
  ],
  "body_shape": [
    {
      "id": 36,
      "value": "Stratocaster",
      "description": "None provided."
    }
  ],
  "top": [
    {
      "id": 2303,
      "value": "13 Body 27 Top",
      "description": "None provided."
    },
    {
      "id": 2305,
      "value": "8 Body 27 Top",
      "description": "None provided."
    }
  ],
  "back_and_sides": [],
  "body_width": [],
  "body_length": [],
  "body_thickness": [],
  "soundhole": [
    {
      "id": 264,
      "value": "None",
      "description": "None provided."
    }
  ],
  ...
}
      

Params

Param name	Description
shallow optional	Pass true to include trait values, or false to include the IDs of values (faster). Default: false. Value: Must be true or false.
only optional	Pass a comma-separated list of trait keys to look up variance for only those traits. Limiting your search can make the API much faster. For ex: &only=fingerboard_inlay,truss_rod Value: Must be String
brand optional	Filter based on a brand name Value: Must be String
brand_id optional	Filter based on a brand id Value: Must be Integer.
model optional	Filter based on a model name Value: Must be String
model_id optional	Filter based on a model id Value: Must be Integer.
submodel optional	Filter based on a submodel name Value: Must be String
submodel_id optional	Filter based on a submodel id Value: Must be Integer.
year optional	Filter based on a year Value: Must be Integer.
serial_number optional	Filter based on a year provided by a serial number Value: Must be Integer.
approved optional	Value: Must be true or false.
pending optional	Value: Must be true or false.