GET
Get fee schedule result

Overview

Returns a single fee schedule result by its unique ID. Access is scoped — you can only retrieve results for exchanges associated with your API key.
Authorization Required - Include your API key in the x-rulebook-api-access-key header. Contact aaron@rulebookcompany.com to obtain access.

Path Parameters

string (uuid)
required
Unique identifier of the fee schedule result. Obtain IDs from the List Fee Schedule Results endpoint.

Query Parameters

boolean
default:"false"
When true, includes resolved footnotes from the source document in the relationships field.
boolean
default:"false"
When true, includes resolved definitions from the source document in the relationships field.
boolean
default:"false"
When true, includes source_document, source_link, and page_number fields in the result.

Request

With Source and Relationships

Response

object
Fee schedule result object (same schema as items in the list endpoint)
object
Response metadata

Example Response

Error Responses

Authorizations

x-rulebook-api-access-key
string
header
required

API access key provided by Rulebook Company. Contact aaron@rulebookcompany.com to obtain one.

Path Parameters

record_id
string<uuid>
required

Unique identifier of the fee schedule result

Query Parameters

include_footnotes
boolean
default:false

When true, includes resolved footnotes from the source document in the relationships field of each result

include_definitions
boolean
default:false

When true, includes resolved definitions from the source document in the relationships field of each result

include_source
boolean
default:false

When true, includes source_document, source_link, and page_number fields in each result

Response

Fee schedule result

data
object

A single fee/rebate line item extracted from an exchange fee schedule document

meta
object

Metadata for non-paginated responses