Retrieves the specified agent's sales volume for a given time period. If no start and end dates are provided, the data for the past year will be returned.
Sample request:
GET /v1/mls/{string mls uoid or int metrics mls id}/agent/{mls agentId}/volume?startDate=2024-01-01&endDate=2024-12-31
GET
/v1/mls/{mlsId}/agent/{agentId}/volume
curl \
--request GET 'https://api.lwolf.com/brokermetrics/v1/mls/{mlsId}/agent/{agentId}/volume'
Response examples (200)
[
{
"totalVolumePeriod": 42.0,
"listSideVolumePeriod": 42.0,
"buySideVolumePeriod": 42.0,
"totalUnitsPeriod": 42.0,
"totalVolumePriorYR": 42.0,
"listSideVolumePriorYR": 42.0,
"buySideVolumePriorYR": 42.0,
"totalUnitsPriorYR": 42.0
}
]
Response examples (200)
[
{
"totalVolumePeriod": 42.0,
"listSideVolumePeriod": 42.0,
"buySideVolumePeriod": 42.0,
"totalUnitsPeriod": 42.0,
"totalVolumePriorYR": 42.0,
"listSideVolumePriorYR": 42.0,
"buySideVolumePriorYR": 42.0,
"totalUnitsPriorYR": 42.0
}
]
Response examples (200)
[
{
"totalVolumePeriod": 42.0,
"listSideVolumePeriod": 42.0,
"buySideVolumePeriod": 42.0,
"totalUnitsPeriod": 42.0,
"totalVolumePriorYR": 42.0,
"listSideVolumePriorYR": 42.0,
"buySideVolumePriorYR": 42.0,
"totalUnitsPriorYR": 42.0
}
]
Response examples (200)
[
{
"totalVolumePeriod": 42.0,
"listSideVolumePeriod": 42.0,
"buySideVolumePeriod": 42.0,
"totalUnitsPeriod": 42.0,
"totalVolumePriorYR": 42.0,
"listSideVolumePriorYR": 42.0,
"buySideVolumePriorYR": 42.0,
"totalUnitsPriorYR": 42.0
}
]
Response examples (200)
[
{
"totalVolumePeriod": 42.0,
"listSideVolumePeriod": 42.0,
"buySideVolumePeriod": 42.0,
"totalUnitsPeriod": 42.0,
"totalVolumePriorYR": 42.0,
"listSideVolumePriorYR": 42.0,
"buySideVolumePriorYR": 42.0,
"totalUnitsPriorYR": 42.0
}
]
Response examples (200)
[
{
"totalVolumePeriod": 42.0,
"listSideVolumePeriod": 42.0,
"buySideVolumePeriod": 42.0,
"totalUnitsPeriod": 42.0,
"totalVolumePriorYR": 42.0,
"listSideVolumePriorYR": 42.0,
"buySideVolumePriorYR": 42.0,
"totalUnitsPriorYR": 42.0
}
]
Response examples (200)
[
{
"totalVolumePeriod": 42.0,
"listSideVolumePeriod": 42.0,
"buySideVolumePeriod": 42.0,
"totalUnitsPeriod": 42.0,
"totalVolumePriorYR": 42.0,
"listSideVolumePriorYR": 42.0,
"buySideVolumePriorYR": 42.0,
"totalUnitsPriorYR": 42.0
}
]
Response examples (200)
[
{
"totalVolumePeriod": 42.0,
"listSideVolumePeriod": 42.0,
"buySideVolumePeriod": 42.0,
"totalUnitsPeriod": 42.0,
"totalVolumePriorYR": 42.0,
"listSideVolumePriorYR": 42.0,
"buySideVolumePriorYR": 42.0,
"totalUnitsPriorYR": 42.0
}
]
Response examples (200)
[
{
"totalVolumePeriod": 42.0,
"listSideVolumePeriod": 42.0,
"buySideVolumePeriod": 42.0,
"totalUnitsPeriod": 42.0,
"totalVolumePriorYR": 42.0,
"listSideVolumePriorYR": 42.0,
"buySideVolumePriorYR": 42.0,
"totalUnitsPriorYR": 42.0
}
]
Response examples (200)
[
{
"totalVolumePeriod": 42.0,
"listSideVolumePeriod": 42.0,
"buySideVolumePeriod": 42.0,
"totalUnitsPeriod": 42.0,
"totalVolumePriorYR": 42.0,
"listSideVolumePriorYR": 42.0,
"buySideVolumePriorYR": 42.0,
"totalUnitsPriorYR": 42.0
}
]
Response examples (200)
[
{
"totalVolumePeriod": 42.0,
"listSideVolumePeriod": 42.0,
"buySideVolumePeriod": 42.0,
"totalUnitsPeriod": 42.0,
"totalVolumePriorYR": 42.0,
"listSideVolumePriorYR": 42.0,
"buySideVolumePriorYR": 42.0,
"totalUnitsPriorYR": 42.0
}
]
Response examples (200)
[
{
"totalVolumePeriod": 42.0,
"listSideVolumePeriod": 42.0,
"buySideVolumePeriod": 42.0,
"totalUnitsPeriod": 42.0,
"totalVolumePriorYR": 42.0,
"listSideVolumePriorYR": 42.0,
"buySideVolumePriorYR": 42.0,
"totalUnitsPriorYR": 42.0
}
]
Response examples (200)
[
{
"totalVolumePeriod": 42.0,
"listSideVolumePeriod": 42.0,
"buySideVolumePeriod": 42.0,
"totalUnitsPeriod": 42.0,
"totalVolumePriorYR": 42.0,
"listSideVolumePriorYR": 42.0,
"buySideVolumePriorYR": 42.0,
"totalUnitsPriorYR": 42.0
}
]
Response examples (200)
[
{
"totalVolumePeriod": 42.0,
"listSideVolumePeriod": 42.0,
"buySideVolumePeriod": 42.0,
"totalUnitsPeriod": 42.0,
"totalVolumePriorYR": 42.0,
"listSideVolumePriorYR": 42.0,
"buySideVolumePriorYR": 42.0,
"totalUnitsPriorYR": 42.0
}
]
Response examples (200)
[
{
"totalVolumePeriod": 42.0,
"listSideVolumePeriod": 42.0,
"buySideVolumePeriod": 42.0,
"totalUnitsPeriod": 42.0,
"totalVolumePriorYR": 42.0,
"listSideVolumePriorYR": 42.0,
"buySideVolumePriorYR": 42.0,
"totalUnitsPriorYR": 42.0
}
]
Response examples (200)
[
{
"totalVolumePeriod": 42.0,
"listSideVolumePeriod": 42.0,
"buySideVolumePeriod": 42.0,
"totalUnitsPeriod": 42.0,
"totalVolumePriorYR": 42.0,
"listSideVolumePriorYR": 42.0,
"buySideVolumePriorYR": 42.0,
"totalUnitsPriorYR": 42.0
}
]
Response examples (200)
[
{
"totalVolumePeriod": 42.0,
"listSideVolumePeriod": 42.0,
"buySideVolumePeriod": 42.0,
"totalUnitsPeriod": 42.0,
"totalVolumePriorYR": 42.0,
"listSideVolumePriorYR": 42.0,
"buySideVolumePriorYR": 42.0,
"totalUnitsPriorYR": 42.0
}
]
Response examples (200)
[
{
"totalVolumePeriod": 42.0,
"listSideVolumePeriod": 42.0,
"buySideVolumePeriod": 42.0,
"totalUnitsPeriod": 42.0,
"totalVolumePriorYR": 42.0,
"listSideVolumePriorYR": 42.0,
"buySideVolumePriorYR": 42.0,
"totalUnitsPriorYR": 42.0
}
]
Response examples (200)
[
{
"totalVolumePeriod": 42.0,
"listSideVolumePeriod": 42.0,
"buySideVolumePeriod": 42.0,
"totalUnitsPeriod": 42.0,
"totalVolumePriorYR": 42.0,
"listSideVolumePriorYR": 42.0,
"buySideVolumePriorYR": 42.0,
"totalUnitsPriorYR": 42.0
}
]
Response examples (200)
[
{
"totalVolumePeriod": 42.0,
"listSideVolumePeriod": 42.0,
"buySideVolumePeriod": 42.0,
"totalUnitsPeriod": 42.0,
"totalVolumePriorYR": 42.0,
"listSideVolumePriorYR": 42.0,
"buySideVolumePriorYR": 42.0,
"totalUnitsPriorYR": 42.0
}
]
Response examples (200)
[
{
"totalVolumePeriod": 42.0,
"listSideVolumePeriod": 42.0,
"buySideVolumePeriod": 42.0,
"totalUnitsPeriod": 42.0,
"totalVolumePriorYR": 42.0,
"listSideVolumePriorYR": 42.0,
"buySideVolumePriorYR": 42.0,
"totalUnitsPriorYR": 42.0
}
]
Response examples (200)
[
{
"totalVolumePeriod": 42.0,
"listSideVolumePeriod": 42.0,
"buySideVolumePeriod": 42.0,
"totalUnitsPeriod": 42.0,
"totalVolumePriorYR": 42.0,
"listSideVolumePriorYR": 42.0,
"buySideVolumePriorYR": 42.0,
"totalUnitsPriorYR": 42.0
}
]
Response examples (200)
[
{
"totalVolumePeriod": 42.0,
"listSideVolumePeriod": 42.0,
"buySideVolumePeriod": 42.0,
"totalUnitsPeriod": 42.0,
"totalVolumePriorYR": 42.0,
"listSideVolumePriorYR": 42.0,
"buySideVolumePriorYR": 42.0,
"totalUnitsPriorYR": 42.0
}
]
Response examples (200)
[
{
"totalVolumePeriod": 42.0,
"listSideVolumePeriod": 42.0,
"buySideVolumePeriod": 42.0,
"totalUnitsPeriod": 42.0,
"totalVolumePriorYR": 42.0,
"listSideVolumePriorYR": 42.0,
"buySideVolumePriorYR": 42.0,
"totalUnitsPriorYR": 42.0
}
]
Response examples (200)
[
{
"totalVolumePeriod": 42.0,
"listSideVolumePeriod": 42.0,
"buySideVolumePeriod": 42.0,
"totalUnitsPeriod": 42.0,
"totalVolumePriorYR": 42.0,
"listSideVolumePriorYR": 42.0,
"buySideVolumePriorYR": 42.0,
"totalUnitsPriorYR": 42.0
}
]
Response examples (200)
[
{
"totalVolumePeriod": 42.0,
"listSideVolumePeriod": 42.0,
"buySideVolumePeriod": 42.0,
"totalUnitsPeriod": 42.0,
"totalVolumePriorYR": 42.0,
"listSideVolumePriorYR": 42.0,
"buySideVolumePriorYR": 42.0,
"totalUnitsPriorYR": 42.0
}
]
Response examples (200)
[
{
"totalVolumePeriod": 42.0,
"listSideVolumePeriod": 42.0,
"buySideVolumePeriod": 42.0,
"totalUnitsPeriod": 42.0,
"totalVolumePriorYR": 42.0,
"listSideVolumePriorYR": 42.0,
"buySideVolumePriorYR": 42.0,
"totalUnitsPriorYR": 42.0
}
]
Response examples (200)
[
{
"totalVolumePeriod": 42.0,
"listSideVolumePeriod": 42.0,
"buySideVolumePeriod": 42.0,
"totalUnitsPeriod": 42.0,
"totalVolumePriorYR": 42.0,
"listSideVolumePriorYR": 42.0,
"buySideVolumePriorYR": 42.0,
"totalUnitsPriorYR": 42.0
}
]
Response examples (200)
[
{
"totalVolumePeriod": 42.0,
"listSideVolumePeriod": 42.0,
"buySideVolumePeriod": 42.0,
"totalUnitsPeriod": 42.0,
"totalVolumePriorYR": 42.0,
"listSideVolumePriorYR": 42.0,
"buySideVolumePriorYR": 42.0,
"totalUnitsPriorYR": 42.0
}
]
Response examples (200)
[
{
"totalVolumePeriod": 42.0,
"listSideVolumePeriod": 42.0,
"buySideVolumePeriod": 42.0,
"totalUnitsPeriod": 42.0,
"totalVolumePriorYR": 42.0,
"listSideVolumePriorYR": 42.0,
"buySideVolumePriorYR": 42.0,
"totalUnitsPriorYR": 42.0
}
]
Response examples (200)
[
{
"totalVolumePeriod": 42.0,
"listSideVolumePeriod": 42.0,
"buySideVolumePeriod": 42.0,
"totalUnitsPeriod": 42.0,
"totalVolumePriorYR": 42.0,
"listSideVolumePriorYR": 42.0,
"buySideVolumePriorYR": 42.0,
"totalUnitsPriorYR": 42.0
}
]
Response examples (200)
[
{
"totalVolumePeriod": 42.0,
"listSideVolumePeriod": 42.0,
"buySideVolumePeriod": 42.0,
"totalUnitsPeriod": 42.0,
"totalVolumePriorYR": 42.0,
"listSideVolumePriorYR": 42.0,
"buySideVolumePriorYR": 42.0,
"totalUnitsPriorYR": 42.0
}
]
Response examples (200)
[
{
"totalVolumePeriod": 42.0,
"listSideVolumePeriod": 42.0,
"buySideVolumePeriod": 42.0,
"totalUnitsPeriod": 42.0,
"totalVolumePriorYR": 42.0,
"listSideVolumePriorYR": 42.0,
"buySideVolumePriorYR": 42.0,
"totalUnitsPriorYR": 42.0
}
]
Response examples (200)
[
{
"totalVolumePeriod": 42.0,
"listSideVolumePeriod": 42.0,
"buySideVolumePeriod": 42.0,
"totalUnitsPeriod": 42.0,
"totalVolumePriorYR": 42.0,
"listSideVolumePriorYR": 42.0,
"buySideVolumePriorYR": 42.0,
"totalUnitsPriorYR": 42.0
}
]
Response examples (200)
[
{
"totalVolumePeriod": 42.0,
"listSideVolumePeriod": 42.0,
"buySideVolumePeriod": 42.0,
"totalUnitsPeriod": 42.0,
"totalVolumePriorYR": 42.0,
"listSideVolumePriorYR": 42.0,
"buySideVolumePriorYR": 42.0,
"totalUnitsPriorYR": 42.0
}
]
Response examples (200)
[
{
"totalVolumePeriod": 42.0,
"listSideVolumePeriod": 42.0,
"buySideVolumePeriod": 42.0,
"totalUnitsPeriod": 42.0,
"totalVolumePriorYR": 42.0,
"listSideVolumePriorYR": 42.0,
"buySideVolumePriorYR": 42.0,
"totalUnitsPriorYR": 42.0
}
]
Response examples (200)
<?xml version="1.0" encoding="UTF-8"?>
<root type="array">
<root>
<totalVolumePeriod type="float">42.0</totalVolumePeriod>
<listSideVolumePeriod type="float">42.0</listSideVolumePeriod>
<buySideVolumePeriod type="float">42.0</buySideVolumePeriod>
<totalUnitsPeriod type="float">42.0</totalUnitsPeriod>
<totalVolumePriorYR type="float">42.0</totalVolumePriorYR>
<listSideVolumePriorYR type="float">42.0</listSideVolumePriorYR>
<buySideVolumePriorYR type="float">42.0</buySideVolumePriorYR>
<totalUnitsPriorYR type="float">42.0</totalUnitsPriorYR>
</root>
</root>
Response examples (200)
[
{
"totalVolumePeriod": 42.0,
"listSideVolumePeriod": 42.0,
"buySideVolumePeriod": 42.0,
"totalUnitsPeriod": 42.0,
"totalVolumePriorYR": 42.0,
"listSideVolumePriorYR": 42.0,
"buySideVolumePriorYR": 42.0,
"totalUnitsPriorYR": 42.0
}
]