Retrieves an agent's coverage details for a specified time period and optional filters.

GET /v1/mls/{mlsId}/agent/{agentId}/coverage

Sample request:

GET /v1/mls/{string mls uoid or int metrics mls id}/agent/{mls agentId}/coverage?startDate=2023-03-18&endDate=2024-03-18&areaType=City&statusCode={status code}

Path parameters

  • mlsId string Required

    MLS unique ID or metrics MLS ID.

  • agentId string Required

    Agent's unique identifier.

Query parameters

  • startDate string(date-time)

    Optional start date for coverage data. Defaults to one year before the current date.

  • endDate string(date-time)

    Optional end date for coverage data. Defaults to the current date.

  • areaType string

    Optional area filter (e.g., City, County). Defaults to "city".

  • statusCode string

    Optional status code filter (e.g., S for Sold). Defaults to "S".

Responses

  • 200

    Returns the coverage records for the specified agent.

    Hide response attributes Show response attributes object
    • rank integer(int32) | null
    • areaType string | null
    • area string | null
    • listUnits number(double) | null
    • listVolume number(double) | null
    • sellUnits number(double) | null
    • sellVolume number(double) | null
    • totalUnits number(double) | null
    • totalVolume number(double) | null
    • totalUnitsPercent number(double) | null
    • totalVolumePercent number(double) | null
    Hide response attributes Show response attributes object
    • rank integer(int32) | null
    • areaType string | null
    • area string | null
    • listUnits number(double) | null
    • listVolume number(double) | null
    • sellUnits number(double) | null
    • sellVolume number(double) | null
    • totalUnits number(double) | null
    • totalVolume number(double) | null
    • totalUnitsPercent number(double) | null
    • totalVolumePercent number(double) | null
    Hide response attributes Show response attributes object
    • rank integer(int32) | null
    • areaType string | null
    • area string | null
    • listUnits number(double) | null
    • listVolume number(double) | null
    • sellUnits number(double) | null
    • sellVolume number(double) | null
    • totalUnits number(double) | null
    • totalVolume number(double) | null
    • totalUnitsPercent number(double) | null
    • totalVolumePercent number(double) | null
    Hide response attributes Show response attributes object
    • rank integer(int32) | null
    • areaType string | null
    • area string | null
    • listUnits number(double) | null
    • listVolume number(double) | null
    • sellUnits number(double) | null
    • sellVolume number(double) | null
    • totalUnits number(double) | null
    • totalVolume number(double) | null
    • totalUnitsPercent number(double) | null
    • totalVolumePercent number(double) | null
    Hide response attributes Show response attributes object
    • rank integer(int32) | null
    • areaType string | null
    • area string | null
    • listUnits number(double) | null
    • listVolume number(double) | null
    • sellUnits number(double) | null
    • sellVolume number(double) | null
    • totalUnits number(double) | null
    • totalVolume number(double) | null
    • totalUnitsPercent number(double) | null
    • totalVolumePercent number(double) | null
    Hide response attributes Show response attributes object
    • rank integer(int32) | null
    • areaType string | null
    • area string | null
    • listUnits number(double) | null
    • listVolume number(double) | null
    • sellUnits number(double) | null
    • sellVolume number(double) | null
    • totalUnits number(double) | null
    • totalVolume number(double) | null
    • totalUnitsPercent number(double) | null
    • totalVolumePercent number(double) | null
    Hide response attributes Show response attributes object
    • rank integer(int32) | null
    • areaType string | null
    • area string | null
    • listUnits number(double) | null
    • listVolume number(double) | null
    • sellUnits number(double) | null
    • sellVolume number(double) | null
    • totalUnits number(double) | null
    • totalVolume number(double) | null
    • totalUnitsPercent number(double) | null
    • totalVolumePercent number(double) | null
    Hide response attributes Show response attributes object
    • rank integer(int32) | null
    • areaType string | null
    • area string | null
    • listUnits number(double) | null
    • listVolume number(double) | null
    • sellUnits number(double) | null
    • sellVolume number(double) | null
    • totalUnits number(double) | null
    • totalVolume number(double) | null
    • totalUnitsPercent number(double) | null
    • totalVolumePercent number(double) | null
    Hide response attributes Show response attributes object
    • rank integer(int32) | null
    • areaType string | null
    • area string | null
    • listUnits number(double) | null
    • listVolume number(double) | null
    • sellUnits number(double) | null
    • sellVolume number(double) | null
    • totalUnits number(double) | null
    • totalVolume number(double) | null
    • totalUnitsPercent number(double) | null
    • totalVolumePercent number(double) | null
    Hide response attributes Show response attributes object
    • rank integer(int32) | null
    • areaType string | null
    • area string | null
    • listUnits number(double) | null
    • listVolume number(double) | null
    • sellUnits number(double) | null
    • sellVolume number(double) | null
    • totalUnits number(double) | null
    • totalVolume number(double) | null
    • totalUnitsPercent number(double) | null
    • totalVolumePercent number(double) | null
    Hide response attributes Show response attributes object
    • rank integer(int32) | null
    • areaType string | null
    • area string | null
    • listUnits number(double) | null
    • listVolume number(double) | null
    • sellUnits number(double) | null
    • sellVolume number(double) | null
    • totalUnits number(double) | null
    • totalVolume number(double) | null
    • totalUnitsPercent number(double) | null
    • totalVolumePercent number(double) | null
    Hide response attributes Show response attributes object
    • rank integer(int32) | null
    • areaType string | null
    • area string | null
    • listUnits number(double) | null
    • listVolume number(double) | null
    • sellUnits number(double) | null
    • sellVolume number(double) | null
    • totalUnits number(double) | null
    • totalVolume number(double) | null
    • totalUnitsPercent number(double) | null
    • totalVolumePercent number(double) | null
    Hide response attributes Show response attributes object
    • rank integer(int32) | null
    • areaType string | null
    • area string | null
    • listUnits number(double) | null
    • listVolume number(double) | null
    • sellUnits number(double) | null
    • sellVolume number(double) | null
    • totalUnits number(double) | null
    • totalVolume number(double) | null
    • totalUnitsPercent number(double) | null
    • totalVolumePercent number(double) | null
    Hide response attributes Show response attributes object
    • rank integer(int32) | null
    • areaType string | null
    • area string | null
    • listUnits number(double) | null
    • listVolume number(double) | null
    • sellUnits number(double) | null
    • sellVolume number(double) | null
    • totalUnits number(double) | null
    • totalVolume number(double) | null
    • totalUnitsPercent number(double) | null
    • totalVolumePercent number(double) | null
    Hide response attributes Show response attributes object
    • rank integer(int32) | null
    • areaType string | null
    • area string | null
    • listUnits number(double) | null
    • listVolume number(double) | null
    • sellUnits number(double) | null
    • sellVolume number(double) | null
    • totalUnits number(double) | null
    • totalVolume number(double) | null
    • totalUnitsPercent number(double) | null
    • totalVolumePercent number(double) | null
    Hide response attributes Show response attributes object
    • rank integer(int32) | null
    • areaType string | null
    • area string | null
    • listUnits number(double) | null
    • listVolume number(double) | null
    • sellUnits number(double) | null
    • sellVolume number(double) | null
    • totalUnits number(double) | null
    • totalVolume number(double) | null
    • totalUnitsPercent number(double) | null
    • totalVolumePercent number(double) | null
    Hide response attributes Show response attributes object
    • rank integer(int32) | null
    • areaType string | null
    • area string | null
    • listUnits number(double) | null
    • listVolume number(double) | null
    • sellUnits number(double) | null
    • sellVolume number(double) | null
    • totalUnits number(double) | null
    • totalVolume number(double) | null
    • totalUnitsPercent number(double) | null
    • totalVolumePercent number(double) | null
    Hide response attributes Show response attributes object
    • rank integer(int32) | null
    • areaType string | null
    • area string | null
    • listUnits number(double) | null
    • listVolume number(double) | null
    • sellUnits number(double) | null
    • sellVolume number(double) | null
    • totalUnits number(double) | null
    • totalVolume number(double) | null
    • totalUnitsPercent number(double) | null
    • totalVolumePercent number(double) | null
    Hide response attributes Show response attributes object
    • rank integer(int32) | null
    • areaType string | null
    • area string | null
    • listUnits number(double) | null
    • listVolume number(double) | null
    • sellUnits number(double) | null
    • sellVolume number(double) | null
    • totalUnits number(double) | null
    • totalVolume number(double) | null
    • totalUnitsPercent number(double) | null
    • totalVolumePercent number(double) | null
    Hide response attributes Show response attributes object
    • rank integer(int32) | null
    • areaType string | null
    • area string | null
    • listUnits number(double) | null
    • listVolume number(double) | null
    • sellUnits number(double) | null
    • sellVolume number(double) | null
    • totalUnits number(double) | null
    • totalVolume number(double) | null
    • totalUnitsPercent number(double) | null
    • totalVolumePercent number(double) | null
    Hide response attributes Show response attributes object
    • rank integer(int32) | null
    • areaType string | null
    • area string | null
    • listUnits number(double) | null
    • listVolume number(double) | null
    • sellUnits number(double) | null
    • sellVolume number(double) | null
    • totalUnits number(double) | null
    • totalVolume number(double) | null
    • totalUnitsPercent number(double) | null
    • totalVolumePercent number(double) | null
    Hide response attributes Show response attributes object
    • rank integer(int32) | null
    • areaType string | null
    • area string | null
    • listUnits number(double) | null
    • listVolume number(double) | null
    • sellUnits number(double) | null
    • sellVolume number(double) | null
    • totalUnits number(double) | null
    • totalVolume number(double) | null
    • totalUnitsPercent number(double) | null
    • totalVolumePercent number(double) | null
    Hide response attributes Show response attributes object
    • rank integer(int32) | null
    • areaType string | null
    • area string | null
    • listUnits number(double) | null
    • listVolume number(double) | null
    • sellUnits number(double) | null
    • sellVolume number(double) | null
    • totalUnits number(double) | null
    • totalVolume number(double) | null
    • totalUnitsPercent number(double) | null
    • totalVolumePercent number(double) | null
    Hide response attributes Show response attributes object
    • rank integer(int32) | null
    • areaType string | null
    • area string | null
    • listUnits number(double) | null
    • listVolume number(double) | null
    • sellUnits number(double) | null
    • sellVolume number(double) | null
    • totalUnits number(double) | null
    • totalVolume number(double) | null
    • totalUnitsPercent number(double) | null
    • totalVolumePercent number(double) | null
    Hide response attributes Show response attributes object
    • rank integer(int32) | null
    • areaType string | null
    • area string | null
    • listUnits number(double) | null
    • listVolume number(double) | null
    • sellUnits number(double) | null
    • sellVolume number(double) | null
    • totalUnits number(double) | null
    • totalVolume number(double) | null
    • totalUnitsPercent number(double) | null
    • totalVolumePercent number(double) | null
    Hide response attributes Show response attributes object
    • rank integer(int32) | null
    • areaType string | null
    • area string | null
    • listUnits number(double) | null
    • listVolume number(double) | null
    • sellUnits number(double) | null
    • sellVolume number(double) | null
    • totalUnits number(double) | null
    • totalVolume number(double) | null
    • totalUnitsPercent number(double) | null
    • totalVolumePercent number(double) | null
    Hide response attributes Show response attributes object
    • rank integer(int32) | null
    • areaType string | null
    • area string | null
    • listUnits number(double) | null
    • listVolume number(double) | null
    • sellUnits number(double) | null
    • sellVolume number(double) | null
    • totalUnits number(double) | null
    • totalVolume number(double) | null
    • totalUnitsPercent number(double) | null
    • totalVolumePercent number(double) | null
    Hide response attributes Show response attributes object
    • rank integer(int32) | null
    • areaType string | null
    • area string | null
    • listUnits number(double) | null
    • listVolume number(double) | null
    • sellUnits number(double) | null
    • sellVolume number(double) | null
    • totalUnits number(double) | null
    • totalVolume number(double) | null
    • totalUnitsPercent number(double) | null
    • totalVolumePercent number(double) | null
    Hide response attributes Show response attributes object
    • rank integer(int32) | null
    • areaType string | null
    • area string | null
    • listUnits number(double) | null
    • listVolume number(double) | null
    • sellUnits number(double) | null
    • sellVolume number(double) | null
    • totalUnits number(double) | null
    • totalVolume number(double) | null
    • totalUnitsPercent number(double) | null
    • totalVolumePercent number(double) | null
    Hide response attributes Show response attributes object
    • rank integer(int32) | null
    • areaType string | null
    • area string | null
    • listUnits number(double) | null
    • listVolume number(double) | null
    • sellUnits number(double) | null
    • sellVolume number(double) | null
    • totalUnits number(double) | null
    • totalVolume number(double) | null
    • totalUnitsPercent number(double) | null
    • totalVolumePercent number(double) | null
    Hide response attributes Show response attributes object
    • rank integer(int32) | null
    • areaType string | null
    • area string | null
    • listUnits number(double) | null
    • listVolume number(double) | null
    • sellUnits number(double) | null
    • sellVolume number(double) | null
    • totalUnits number(double) | null
    • totalVolume number(double) | null
    • totalUnitsPercent number(double) | null
    • totalVolumePercent number(double) | null
    Hide response attributes Show response attributes object
    • rank integer(int32) | null
    • areaType string | null
    • area string | null
    • listUnits number(double) | null
    • listVolume number(double) | null
    • sellUnits number(double) | null
    • sellVolume number(double) | null
    • totalUnits number(double) | null
    • totalVolume number(double) | null
    • totalUnitsPercent number(double) | null
    • totalVolumePercent number(double) | null
    Hide response attributes Show response attributes object
    • rank integer(int32) | null
    • areaType string | null
    • area string | null
    • listUnits number(double) | null
    • listVolume number(double) | null
    • sellUnits number(double) | null
    • sellVolume number(double) | null
    • totalUnits number(double) | null
    • totalVolume number(double) | null
    • totalUnitsPercent number(double) | null
    • totalVolumePercent number(double) | null
    Hide response attributes Show response attributes object
    • rank integer(int32) | null
    • areaType string | null
    • area string | null
    • listUnits number(double) | null
    • listVolume number(double) | null
    • sellUnits number(double) | null
    • sellVolume number(double) | null
    • totalUnits number(double) | null
    • totalVolume number(double) | null
    • totalUnitsPercent number(double) | null
    • totalVolumePercent number(double) | null
    Hide response attributes Show response attributes object
    • rank integer(int32) | null
    • areaType string | null
    • area string | null
    • listUnits number(double) | null
    • listVolume number(double) | null
    • sellUnits number(double) | null
    • sellVolume number(double) | null
    • totalUnits number(double) | null
    • totalVolume number(double) | null
    • totalUnitsPercent number(double) | null
    • totalVolumePercent number(double) | null
    Hide response attributes Show response attributes object
    • rank integer(int32) | null
    • areaType string | null
    • area string | null
    • listUnits number(double) | null
    • listVolume number(double) | null
    • sellUnits number(double) | null
    • sellVolume number(double) | null
    • totalUnits number(double) | null
    • totalVolume number(double) | null
    • totalUnitsPercent number(double) | null
    • totalVolumePercent number(double) | null
    Hide response attributes Show response attributes object
    • rank integer(int32) | null
    • areaType string | null
    • area string | null
    • listUnits number(double) | null
    • listVolume number(double) | null
    • sellUnits number(double) | null
    • sellVolume number(double) | null
    • totalUnits number(double) | null
    • totalVolume number(double) | null
    • totalUnitsPercent number(double) | null
    • totalVolumePercent number(double) | null
    Hide response attributes Show response attributes object
    • rank integer(int32) | null
    • areaType string | null
    • area string | null
    • listUnits number(double) | null
    • listVolume number(double) | null
    • sellUnits number(double) | null
    • sellVolume number(double) | null
    • totalUnits number(double) | null
    • totalVolume number(double) | null
    • totalUnitsPercent number(double) | null
    • totalVolumePercent number(double) | null
    Hide response attributes Show response attributes object
    • rank integer(int32) | null
    • areaType string | null
    • area string | null
    • listUnits number(double) | null
    • listVolume number(double) | null
    • sellUnits number(double) | null
    • sellVolume number(double) | null
    • totalUnits number(double) | null
    • totalVolume number(double) | null
    • totalUnitsPercent number(double) | null
    • totalVolumePercent number(double) | null
    Hide response attributes Show response attributes object
    • rank integer(int32) | null
    • areaType string | null
    • area string | null
    • listUnits number(double) | null
    • listVolume number(double) | null
    • sellUnits number(double) | null
    • sellVolume number(double) | null
    • totalUnits number(double) | null
    • totalVolume number(double) | null
    • totalUnitsPercent number(double) | null
    • totalVolumePercent number(double) | null
  • 404

    No coverage records were found for the specified criteria.

  • 500

    An internal server error occurred.

GET /v1/mls/{mlsId}/agent/{agentId}/coverage
curl \
 --request GET 'https://api.lwolf.com/brokermetrics/v1/mls/{mlsId}/agent/{agentId}/coverage'
Response examples (200)
[
  {
    "rank": 42,
    "areaType": "string",
    "area": "string",
    "listUnits": 42.0,
    "listVolume": 42.0,
    "sellUnits": 42.0,
    "sellVolume": 42.0,
    "totalUnits": 42.0,
    "totalVolume": 42.0,
    "totalUnitsPercent": 42.0,
    "totalVolumePercent": 42.0
  }
]
Response examples (200)
[
  {
    "rank": 42,
    "areaType": "string",
    "area": "string",
    "listUnits": 42.0,
    "listVolume": 42.0,
    "sellUnits": 42.0,
    "sellVolume": 42.0,
    "totalUnits": 42.0,
    "totalVolume": 42.0,
    "totalUnitsPercent": 42.0,
    "totalVolumePercent": 42.0
  }
]
Response examples (200)
[
  {
    "rank": 42,
    "areaType": "string",
    "area": "string",
    "listUnits": 42.0,
    "listVolume": 42.0,
    "sellUnits": 42.0,
    "sellVolume": 42.0,
    "totalUnits": 42.0,
    "totalVolume": 42.0,
    "totalUnitsPercent": 42.0,
    "totalVolumePercent": 42.0
  }
]
Response examples (200)
[
  {
    "rank": 42,
    "areaType": "string",
    "area": "string",
    "listUnits": 42.0,
    "listVolume": 42.0,
    "sellUnits": 42.0,
    "sellVolume": 42.0,
    "totalUnits": 42.0,
    "totalVolume": 42.0,
    "totalUnitsPercent": 42.0,
    "totalVolumePercent": 42.0
  }
]
Response examples (200)
[
  {
    "rank": 42,
    "areaType": "string",
    "area": "string",
    "listUnits": 42.0,
    "listVolume": 42.0,
    "sellUnits": 42.0,
    "sellVolume": 42.0,
    "totalUnits": 42.0,
    "totalVolume": 42.0,
    "totalUnitsPercent": 42.0,
    "totalVolumePercent": 42.0
  }
]
Response examples (200)
[
  {
    "rank": 42,
    "areaType": "string",
    "area": "string",
    "listUnits": 42.0,
    "listVolume": 42.0,
    "sellUnits": 42.0,
    "sellVolume": 42.0,
    "totalUnits": 42.0,
    "totalVolume": 42.0,
    "totalUnitsPercent": 42.0,
    "totalVolumePercent": 42.0
  }
]
Response examples (200)
[
  {
    "rank": 42,
    "areaType": "string",
    "area": "string",
    "listUnits": 42.0,
    "listVolume": 42.0,
    "sellUnits": 42.0,
    "sellVolume": 42.0,
    "totalUnits": 42.0,
    "totalVolume": 42.0,
    "totalUnitsPercent": 42.0,
    "totalVolumePercent": 42.0
  }
]
Response examples (200)
[
  {
    "rank": 42,
    "areaType": "string",
    "area": "string",
    "listUnits": 42.0,
    "listVolume": 42.0,
    "sellUnits": 42.0,
    "sellVolume": 42.0,
    "totalUnits": 42.0,
    "totalVolume": 42.0,
    "totalUnitsPercent": 42.0,
    "totalVolumePercent": 42.0
  }
]
Response examples (200)
[
  {
    "rank": 42,
    "areaType": "string",
    "area": "string",
    "listUnits": 42.0,
    "listVolume": 42.0,
    "sellUnits": 42.0,
    "sellVolume": 42.0,
    "totalUnits": 42.0,
    "totalVolume": 42.0,
    "totalUnitsPercent": 42.0,
    "totalVolumePercent": 42.0
  }
]
Response examples (200)
[
  {
    "rank": 42,
    "areaType": "string",
    "area": "string",
    "listUnits": 42.0,
    "listVolume": 42.0,
    "sellUnits": 42.0,
    "sellVolume": 42.0,
    "totalUnits": 42.0,
    "totalVolume": 42.0,
    "totalUnitsPercent": 42.0,
    "totalVolumePercent": 42.0
  }
]
Response examples (200)
[
  {
    "rank": 42,
    "areaType": "string",
    "area": "string",
    "listUnits": 42.0,
    "listVolume": 42.0,
    "sellUnits": 42.0,
    "sellVolume": 42.0,
    "totalUnits": 42.0,
    "totalVolume": 42.0,
    "totalUnitsPercent": 42.0,
    "totalVolumePercent": 42.0
  }
]
Response examples (200)
[
  {
    "rank": 42,
    "areaType": "string",
    "area": "string",
    "listUnits": 42.0,
    "listVolume": 42.0,
    "sellUnits": 42.0,
    "sellVolume": 42.0,
    "totalUnits": 42.0,
    "totalVolume": 42.0,
    "totalUnitsPercent": 42.0,
    "totalVolumePercent": 42.0
  }
]
Response examples (200)
[
  {
    "rank": 42,
    "areaType": "string",
    "area": "string",
    "listUnits": 42.0,
    "listVolume": 42.0,
    "sellUnits": 42.0,
    "sellVolume": 42.0,
    "totalUnits": 42.0,
    "totalVolume": 42.0,
    "totalUnitsPercent": 42.0,
    "totalVolumePercent": 42.0
  }
]
Response examples (200)
[
  {
    "rank": 42,
    "areaType": "string",
    "area": "string",
    "listUnits": 42.0,
    "listVolume": 42.0,
    "sellUnits": 42.0,
    "sellVolume": 42.0,
    "totalUnits": 42.0,
    "totalVolume": 42.0,
    "totalUnitsPercent": 42.0,
    "totalVolumePercent": 42.0
  }
]
Response examples (200)
[
  {
    "rank": 42,
    "areaType": "string",
    "area": "string",
    "listUnits": 42.0,
    "listVolume": 42.0,
    "sellUnits": 42.0,
    "sellVolume": 42.0,
    "totalUnits": 42.0,
    "totalVolume": 42.0,
    "totalUnitsPercent": 42.0,
    "totalVolumePercent": 42.0
  }
]
Response examples (200)
[
  {
    "rank": 42,
    "areaType": "string",
    "area": "string",
    "listUnits": 42.0,
    "listVolume": 42.0,
    "sellUnits": 42.0,
    "sellVolume": 42.0,
    "totalUnits": 42.0,
    "totalVolume": 42.0,
    "totalUnitsPercent": 42.0,
    "totalVolumePercent": 42.0
  }
]
Response examples (200)
[
  {
    "rank": 42,
    "areaType": "string",
    "area": "string",
    "listUnits": 42.0,
    "listVolume": 42.0,
    "sellUnits": 42.0,
    "sellVolume": 42.0,
    "totalUnits": 42.0,
    "totalVolume": 42.0,
    "totalUnitsPercent": 42.0,
    "totalVolumePercent": 42.0
  }
]
Response examples (200)
[
  {
    "rank": 42,
    "areaType": "string",
    "area": "string",
    "listUnits": 42.0,
    "listVolume": 42.0,
    "sellUnits": 42.0,
    "sellVolume": 42.0,
    "totalUnits": 42.0,
    "totalVolume": 42.0,
    "totalUnitsPercent": 42.0,
    "totalVolumePercent": 42.0
  }
]
Response examples (200)
[
  {
    "rank": 42,
    "areaType": "string",
    "area": "string",
    "listUnits": 42.0,
    "listVolume": 42.0,
    "sellUnits": 42.0,
    "sellVolume": 42.0,
    "totalUnits": 42.0,
    "totalVolume": 42.0,
    "totalUnitsPercent": 42.0,
    "totalVolumePercent": 42.0
  }
]
Response examples (200)
[
  {
    "rank": 42,
    "areaType": "string",
    "area": "string",
    "listUnits": 42.0,
    "listVolume": 42.0,
    "sellUnits": 42.0,
    "sellVolume": 42.0,
    "totalUnits": 42.0,
    "totalVolume": 42.0,
    "totalUnitsPercent": 42.0,
    "totalVolumePercent": 42.0
  }
]
Response examples (200)
[
  {
    "rank": 42,
    "areaType": "string",
    "area": "string",
    "listUnits": 42.0,
    "listVolume": 42.0,
    "sellUnits": 42.0,
    "sellVolume": 42.0,
    "totalUnits": 42.0,
    "totalVolume": 42.0,
    "totalUnitsPercent": 42.0,
    "totalVolumePercent": 42.0
  }
]
Response examples (200)
[
  {
    "rank": 42,
    "areaType": "string",
    "area": "string",
    "listUnits": 42.0,
    "listVolume": 42.0,
    "sellUnits": 42.0,
    "sellVolume": 42.0,
    "totalUnits": 42.0,
    "totalVolume": 42.0,
    "totalUnitsPercent": 42.0,
    "totalVolumePercent": 42.0
  }
]
Response examples (200)
[
  {
    "rank": 42,
    "areaType": "string",
    "area": "string",
    "listUnits": 42.0,
    "listVolume": 42.0,
    "sellUnits": 42.0,
    "sellVolume": 42.0,
    "totalUnits": 42.0,
    "totalVolume": 42.0,
    "totalUnitsPercent": 42.0,
    "totalVolumePercent": 42.0
  }
]
Response examples (200)
[
  {
    "rank": 42,
    "areaType": "string",
    "area": "string",
    "listUnits": 42.0,
    "listVolume": 42.0,
    "sellUnits": 42.0,
    "sellVolume": 42.0,
    "totalUnits": 42.0,
    "totalVolume": 42.0,
    "totalUnitsPercent": 42.0,
    "totalVolumePercent": 42.0
  }
]
Response examples (200)
[
  {
    "rank": 42,
    "areaType": "string",
    "area": "string",
    "listUnits": 42.0,
    "listVolume": 42.0,
    "sellUnits": 42.0,
    "sellVolume": 42.0,
    "totalUnits": 42.0,
    "totalVolume": 42.0,
    "totalUnitsPercent": 42.0,
    "totalVolumePercent": 42.0
  }
]
Response examples (200)
[
  {
    "rank": 42,
    "areaType": "string",
    "area": "string",
    "listUnits": 42.0,
    "listVolume": 42.0,
    "sellUnits": 42.0,
    "sellVolume": 42.0,
    "totalUnits": 42.0,
    "totalVolume": 42.0,
    "totalUnitsPercent": 42.0,
    "totalVolumePercent": 42.0
  }
]
Response examples (200)
[
  {
    "rank": 42,
    "areaType": "string",
    "area": "string",
    "listUnits": 42.0,
    "listVolume": 42.0,
    "sellUnits": 42.0,
    "sellVolume": 42.0,
    "totalUnits": 42.0,
    "totalVolume": 42.0,
    "totalUnitsPercent": 42.0,
    "totalVolumePercent": 42.0
  }
]
Response examples (200)
[
  {
    "rank": 42,
    "areaType": "string",
    "area": "string",
    "listUnits": 42.0,
    "listVolume": 42.0,
    "sellUnits": 42.0,
    "sellVolume": 42.0,
    "totalUnits": 42.0,
    "totalVolume": 42.0,
    "totalUnitsPercent": 42.0,
    "totalVolumePercent": 42.0
  }
]
Response examples (200)
[
  {
    "rank": 42,
    "areaType": "string",
    "area": "string",
    "listUnits": 42.0,
    "listVolume": 42.0,
    "sellUnits": 42.0,
    "sellVolume": 42.0,
    "totalUnits": 42.0,
    "totalVolume": 42.0,
    "totalUnitsPercent": 42.0,
    "totalVolumePercent": 42.0
  }
]
Response examples (200)
[
  {
    "rank": 42,
    "areaType": "string",
    "area": "string",
    "listUnits": 42.0,
    "listVolume": 42.0,
    "sellUnits": 42.0,
    "sellVolume": 42.0,
    "totalUnits": 42.0,
    "totalVolume": 42.0,
    "totalUnitsPercent": 42.0,
    "totalVolumePercent": 42.0
  }
]
Response examples (200)
[
  {
    "rank": 42,
    "areaType": "string",
    "area": "string",
    "listUnits": 42.0,
    "listVolume": 42.0,
    "sellUnits": 42.0,
    "sellVolume": 42.0,
    "totalUnits": 42.0,
    "totalVolume": 42.0,
    "totalUnitsPercent": 42.0,
    "totalVolumePercent": 42.0
  }
]
Response examples (200)
[
  {
    "rank": 42,
    "areaType": "string",
    "area": "string",
    "listUnits": 42.0,
    "listVolume": 42.0,
    "sellUnits": 42.0,
    "sellVolume": 42.0,
    "totalUnits": 42.0,
    "totalVolume": 42.0,
    "totalUnitsPercent": 42.0,
    "totalVolumePercent": 42.0
  }
]
Response examples (200)
[
  {
    "rank": 42,
    "areaType": "string",
    "area": "string",
    "listUnits": 42.0,
    "listVolume": 42.0,
    "sellUnits": 42.0,
    "sellVolume": 42.0,
    "totalUnits": 42.0,
    "totalVolume": 42.0,
    "totalUnitsPercent": 42.0,
    "totalVolumePercent": 42.0
  }
]
Response examples (200)
[
  {
    "rank": 42,
    "areaType": "string",
    "area": "string",
    "listUnits": 42.0,
    "listVolume": 42.0,
    "sellUnits": 42.0,
    "sellVolume": 42.0,
    "totalUnits": 42.0,
    "totalVolume": 42.0,
    "totalUnitsPercent": 42.0,
    "totalVolumePercent": 42.0
  }
]
Response examples (200)
[
  {
    "rank": 42,
    "areaType": "string",
    "area": "string",
    "listUnits": 42.0,
    "listVolume": 42.0,
    "sellUnits": 42.0,
    "sellVolume": 42.0,
    "totalUnits": 42.0,
    "totalVolume": 42.0,
    "totalUnitsPercent": 42.0,
    "totalVolumePercent": 42.0
  }
]
Response examples (200)
[
  {
    "rank": 42,
    "areaType": "string",
    "area": "string",
    "listUnits": 42.0,
    "listVolume": 42.0,
    "sellUnits": 42.0,
    "sellVolume": 42.0,
    "totalUnits": 42.0,
    "totalVolume": 42.0,
    "totalUnitsPercent": 42.0,
    "totalVolumePercent": 42.0
  }
]
Response examples (200)
<?xml version="1.0" encoding="UTF-8"?>
<root type="array">
  <root>
    <rank type="integer">42</rank>
    <areaType>string</areaType>
    <area>string</area>
    <listUnits type="float">42.0</listUnits>
    <listVolume type="float">42.0</listVolume>
    <sellUnits type="float">42.0</sellUnits>
    <sellVolume type="float">42.0</sellVolume>
    <totalUnits type="float">42.0</totalUnits>
    <totalVolume type="float">42.0</totalVolume>
    <totalUnitsPercent type="float">42.0</totalUnitsPercent>
    <totalVolumePercent type="float">42.0</totalVolumePercent>
  </root>
</root>
Response examples (200)
[
  {
    "rank": 42,
    "areaType": "string",
    "area": "string",
    "listUnits": 42.0,
    "listVolume": 42.0,
    "sellUnits": 42.0,
    "sellVolume": 42.0,
    "totalUnits": 42.0,
    "totalVolume": 42.0,
    "totalUnitsPercent": 42.0,
    "totalVolumePercent": 42.0
  }
]