Skip to main content

GET Partitions

Returns unique values and versions of those values for the partition(s) of a dataset.

GET /partitions/group/{group name}/name/{dataset name}

Optional Request Parameters

None.

Request Headers

header required description default
Authorization optional Contains the word Basic followed by a space and a base64-encoded string of the form "clientid:clientsecret". n/a
Data-API-Version optional Used to specify version of the API to use. version 1

Sample Request

https://api.finra.org/partitions/group/fixedincomemarket/name/treasuryweeklyaggregates

Sample Response



{
    "datasetGroup": "fixedincomemarket",
    "datasetName": "treasuryweeklyaggregates",
    "partitionFields": [
        "beginningOfWeekDate"
    ],
    "availablePartitions": [
        {
            "partitions": [
                "2021-02-15"
            ]
        },
        {
            "partitions": [
                "2021-02-08"
            ]
        },
        {
            "partitions": [
                "2021-02-01"
            ]
        },
        {
            "partitions": [
                "2021-01-25"
            ]
        },
        {
            "partitions": [
                "2021-01-18"
            ]
        },
        {
            "partitions": [
                "2021-01-11"
            ]
        },
        {
            "partitions": [
                "2021-01-04"
            ]
        },
        {
            "partitions": [
                "2020-12-28"
            ]
        },
        {
            "partitions": [
                "2020-12-21"
            ]
        }
    ]
}

Sample Response When Partitions Do Not Exist for Dataset


{
  "statusCode" : 200,
  "statusDescription" : "ok",
  "requestId" : "c2f1ac3c-4fb2-4003-bc0f-c20eaecc94e8",
  "message" : "No partitions found for specified dataset.",
  "partitionAvailabilityRequest" : {
    "action" : "GET",
    "group" : "firm",
    "name" : "registeredIndividual",
    "getDetails" : false
  }
}