Retrieves office's inventory.

GET /v1/Office/inventory

Sample request:

GET /v1/office/inventorymlsId=12345&officeId=oid

Query parameters

  • mlsId string

    The unique identifier of the MLS provider used to filter offices.

  • officeId string

    The identifier for a given office, is unique per MLS

Responses

GET /v1/Office/inventory 
curl \
 --request GET 'https://api.lwolf.com/brokermetrics/v1/Office/inventory'
Response examples (200) 
[
  {
    "forSaleUnits": 42.0,
    "forSaleVolume": 42.0,
    "forSaleDom": 42.0,
    "ucUnits": 42.0,
    "ucVolume": 42.0,
    "ucDom": 42.0
  }
]
Response examples (200) 
[
  {
    "forSaleUnits": 42.0,
    "forSaleVolume": 42.0,
    "forSaleDom": 42.0,
    "ucUnits": 42.0,
    "ucVolume": 42.0,
    "ucDom": 42.0
  }
]
Response examples (200) 
[
  {
    "forSaleUnits": 42.0,
    "forSaleVolume": 42.0,
    "forSaleDom": 42.0,
    "ucUnits": 42.0,
    "ucVolume": 42.0,
    "ucDom": 42.0
  }
]
Response examples (200) 
[
  {
    "forSaleUnits": 42.0,
    "forSaleVolume": 42.0,
    "forSaleDom": 42.0,
    "ucUnits": 42.0,
    "ucVolume": 42.0,
    "ucDom": 42.0
  }
]
Response examples (200) 
[
  {
    "forSaleUnits": 42.0,
    "forSaleVolume": 42.0,
    "forSaleDom": 42.0,
    "ucUnits": 42.0,
    "ucVolume": 42.0,
    "ucDom": 42.0
  }
]
Response examples (200) 
[
  {
    "forSaleUnits": 42.0,
    "forSaleVolume": 42.0,
    "forSaleDom": 42.0,
    "ucUnits": 42.0,
    "ucVolume": 42.0,
    "ucDom": 42.0
  }
]
Response examples (200) 
[
  {
    "forSaleUnits": 42.0,
    "forSaleVolume": 42.0,
    "forSaleDom": 42.0,
    "ucUnits": 42.0,
    "ucVolume": 42.0,
    "ucDom": 42.0
  }
]
Response examples (200) 
[
  {
    "forSaleUnits": 42.0,
    "forSaleVolume": 42.0,
    "forSaleDom": 42.0,
    "ucUnits": 42.0,
    "ucVolume": 42.0,
    "ucDom": 42.0
  }
]
Response examples (200) 
[
  {
    "forSaleUnits": 42.0,
    "forSaleVolume": 42.0,
    "forSaleDom": 42.0,
    "ucUnits": 42.0,
    "ucVolume": 42.0,
    "ucDom": 42.0
  }
]
Response examples (200) 
[
  {
    "forSaleUnits": 42.0,
    "forSaleVolume": 42.0,
    "forSaleDom": 42.0,
    "ucUnits": 42.0,
    "ucVolume": 42.0,
    "ucDom": 42.0
  }
]
Response examples (200) 
[
  {
    "forSaleUnits": 42.0,
    "forSaleVolume": 42.0,
    "forSaleDom": 42.0,
    "ucUnits": 42.0,
    "ucVolume": 42.0,
    "ucDom": 42.0
  }
]
Response examples (200) 
[
  {
    "forSaleUnits": 42.0,
    "forSaleVolume": 42.0,
    "forSaleDom": 42.0,
    "ucUnits": 42.0,
    "ucVolume": 42.0,
    "ucDom": 42.0
  }
]
Response examples (200) 
[
  {
    "forSaleUnits": 42.0,
    "forSaleVolume": 42.0,
    "forSaleDom": 42.0,
    "ucUnits": 42.0,
    "ucVolume": 42.0,
    "ucDom": 42.0
  }
]
Response examples (200) 
[
  {
    "forSaleUnits": 42.0,
    "forSaleVolume": 42.0,
    "forSaleDom": 42.0,
    "ucUnits": 42.0,
    "ucVolume": 42.0,
    "ucDom": 42.0
  }
]
Response examples (200) 
[
  {
    "forSaleUnits": 42.0,
    "forSaleVolume": 42.0,
    "forSaleDom": 42.0,
    "ucUnits": 42.0,
    "ucVolume": 42.0,
    "ucDom": 42.0
  }
]
Response examples (200) 
[
  {
    "forSaleUnits": 42.0,
    "forSaleVolume": 42.0,
    "forSaleDom": 42.0,
    "ucUnits": 42.0,
    "ucVolume": 42.0,
    "ucDom": 42.0
  }
]
Response examples (200) 
[
  {
    "forSaleUnits": 42.0,
    "forSaleVolume": 42.0,
    "forSaleDom": 42.0,
    "ucUnits": 42.0,
    "ucVolume": 42.0,
    "ucDom": 42.0
  }
]
Response examples (200) 
[
  {
    "forSaleUnits": 42.0,
    "forSaleVolume": 42.0,
    "forSaleDom": 42.0,
    "ucUnits": 42.0,
    "ucVolume": 42.0,
    "ucDom": 42.0
  }
]
Response examples (200) 
[
  {
    "forSaleUnits": 42.0,
    "forSaleVolume": 42.0,
    "forSaleDom": 42.0,
    "ucUnits": 42.0,
    "ucVolume": 42.0,
    "ucDom": 42.0
  }
]
Response examples (200) 
[
  {
    "forSaleUnits": 42.0,
    "forSaleVolume": 42.0,
    "forSaleDom": 42.0,
    "ucUnits": 42.0,
    "ucVolume": 42.0,
    "ucDom": 42.0
  }
]
Response examples (200) 
[
  {
    "forSaleUnits": 42.0,
    "forSaleVolume": 42.0,
    "forSaleDom": 42.0,
    "ucUnits": 42.0,
    "ucVolume": 42.0,
    "ucDom": 42.0
  }
]
Response examples (200) 
[
  {
    "forSaleUnits": 42.0,
    "forSaleVolume": 42.0,
    "forSaleDom": 42.0,
    "ucUnits": 42.0,
    "ucVolume": 42.0,
    "ucDom": 42.0
  }
]
Response examples (200) 
[
  {
    "forSaleUnits": 42.0,
    "forSaleVolume": 42.0,
    "forSaleDom": 42.0,
    "ucUnits": 42.0,
    "ucVolume": 42.0,
    "ucDom": 42.0
  }
]
Response examples (200) 
[
  {
    "forSaleUnits": 42.0,
    "forSaleVolume": 42.0,
    "forSaleDom": 42.0,
    "ucUnits": 42.0,
    "ucVolume": 42.0,
    "ucDom": 42.0
  }
]
Response examples (200) 
[
  {
    "forSaleUnits": 42.0,
    "forSaleVolume": 42.0,
    "forSaleDom": 42.0,
    "ucUnits": 42.0,
    "ucVolume": 42.0,
    "ucDom": 42.0
  }
]
Response examples (200) 
[
  {
    "forSaleUnits": 42.0,
    "forSaleVolume": 42.0,
    "forSaleDom": 42.0,
    "ucUnits": 42.0,
    "ucVolume": 42.0,
    "ucDom": 42.0
  }
]
Response examples (200) 
[
  {
    "forSaleUnits": 42.0,
    "forSaleVolume": 42.0,
    "forSaleDom": 42.0,
    "ucUnits": 42.0,
    "ucVolume": 42.0,
    "ucDom": 42.0
  }
]
Response examples (200) 
[
  {
    "forSaleUnits": 42.0,
    "forSaleVolume": 42.0,
    "forSaleDom": 42.0,
    "ucUnits": 42.0,
    "ucVolume": 42.0,
    "ucDom": 42.0
  }
]
Response examples (200) 
[
  {
    "forSaleUnits": 42.0,
    "forSaleVolume": 42.0,
    "forSaleDom": 42.0,
    "ucUnits": 42.0,
    "ucVolume": 42.0,
    "ucDom": 42.0
  }
]
Response examples (200) 
[
  {
    "forSaleUnits": 42.0,
    "forSaleVolume": 42.0,
    "forSaleDom": 42.0,
    "ucUnits": 42.0,
    "ucVolume": 42.0,
    "ucDom": 42.0
  }
]
Response examples (200) 
[
  {
    "forSaleUnits": 42.0,
    "forSaleVolume": 42.0,
    "forSaleDom": 42.0,
    "ucUnits": 42.0,
    "ucVolume": 42.0,
    "ucDom": 42.0
  }
]
Response examples (200) 
[
  {
    "forSaleUnits": 42.0,
    "forSaleVolume": 42.0,
    "forSaleDom": 42.0,
    "ucUnits": 42.0,
    "ucVolume": 42.0,
    "ucDom": 42.0
  }
]
Response examples (200) 
[
  {
    "forSaleUnits": 42.0,
    "forSaleVolume": 42.0,
    "forSaleDom": 42.0,
    "ucUnits": 42.0,
    "ucVolume": 42.0,
    "ucDom": 42.0
  }
]
Response examples (200) 
[
  {
    "forSaleUnits": 42.0,
    "forSaleVolume": 42.0,
    "forSaleDom": 42.0,
    "ucUnits": 42.0,
    "ucVolume": 42.0,
    "ucDom": 42.0
  }
]
Response examples (200) 
[
  {
    "forSaleUnits": 42.0,
    "forSaleVolume": 42.0,
    "forSaleDom": 42.0,
    "ucUnits": 42.0,
    "ucVolume": 42.0,
    "ucDom": 42.0
  }
]
Response examples (200) 
[
  {
    "forSaleUnits": 42.0,
    "forSaleVolume": 42.0,
    "forSaleDom": 42.0,
    "ucUnits": 42.0,
    "ucVolume": 42.0,
    "ucDom": 42.0
  }
]
Response examples (200) 
<?xml version="1.0" encoding="UTF-8"?>
<root type="array">
  <root>
    <forSaleUnits type="float">42.0</forSaleUnits>
    <forSaleVolume type="float">42.0</forSaleVolume>
    <forSaleDom type="float">42.0</forSaleDom>
    <ucUnits type="float">42.0</ucUnits>
    <ucVolume type="float">42.0</ucVolume>
    <ucDom type="float">42.0</ucDom>
  </root>
</root>
Response examples (200) 
[
  {
    "forSaleUnits": 42.0,
    "forSaleVolume": 42.0,
    "forSaleDom": 42.0,
    "ucUnits": 42.0,
    "ucVolume": 42.0,
    "ucDom": 42.0
  }
]
Response examples (400) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400) 
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <type>string</type>
  <title>string</title>
  <status type="integer">42</status>
  <detail>string</detail>
  <instance>string</instance>
</root>
Response examples (400) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404) 
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <type>string</type>
  <title>string</title>
  <status type="integer">42</status>
  <detail>string</detail>
  <instance>string</instance>
</root>
Response examples (404) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}