> ## Documentation Index
> Fetch the complete documentation index at: https://takeprofit.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get the volume footprint row size scale

> The row size scale a settings UI can offer for one security and timeframe, in absolute
quote-currency units - the units `rowSizeValue` and every profile's `rowSize` speak, so
scale values can be echoed back directly: the step every achievable row size is a
multiple of, and the bounds it stays within.

- Measured over the most recent profile periods (a server-configured count, by default
  100), ending at the security's newest stored candle - the window a chart opens on.
- A `rowSizeValue` that is a whole multiple of the step within `[minRowSize, maxRowSize]`
  is answered verbatim by requests over that recent window. History deeper than it can be
  stored more coarsely, so a request reaching far back may resolve a coarser grid, which
  the response and stream report and the echoed `rowSizeValue` follows.
- The step follows how coarsely the stored data of the timeframe is packed, so it differs
  between timeframes and securities and can grow over time - re-read it with the chart
  rather than caching it.
- 404 (`exchange not found`) when the exchange is not served; 404 with the generic
  `requested resource was not found` when the security is not served or the window
  holds no stored data - unlike the profile endpoints, this one cannot tell the two apart.

**Cost:** 1000 credits per request (flat).




## OpenAPI

````yaml /platform-api/specs/openapi.yaml get /api/v1/marketdata/footprint/row-size-scale
openapi: 3.0.3
info:
  title: TakeProfit API (REST)
  version: 0.6.0
  contact:
    email: support@takeprofit.com
  description: |
    Historical marketdata and the security catalog over REST. Live streams
    (candles, volume footprint, order books) are served over WebSocket and
    described by the AsyncAPI document at
    `https://public-api.takeprofit.com/api/v1/marketdata/asyncapi.yaml`.
    Guides (getting an API key, credits and quota, errors) live at
    [takeprofit.com/docs](https://takeprofit.com/docs).

    ## Requests

    - Base URL: `https://public-api.takeprofit.com`.
    - Every endpoint answers `GET` only.
    - Authenticate with the `x-api-key` header; exactly one header value is
      required.
    - Unknown query parameters and repeated scalar parameters are rejected
      with 400.
    - Identify securities with `exchange` and `symbol` as returned by the
      catalog endpoints; internal ids and GUIDs are not accepted (search
      additionally accepts an ISIN as a lookup key).

    ## Credits and quota

    Requests are metered in credits against a fixed quota window of 100000
    credits per 60 seconds, shared by all API keys of the account. Each
    operation states its price; every billed request costs at least 1000
    credits, so an account makes at most 100 requests per minute. Every
    authenticated response carries the window state:

    - `X-RateLimit-Limit` - credits per window;
    - `X-RateLimit-Remaining` - credits still available after this request;
    - `X-RateLimit-Reset` - epoch second the window resets at.

    A request the remaining credits cannot cover is rejected with 429 and
    `Retry-After` (seconds until the window resets); the rejection itself is
    free.

    ## Errors

    Every error response is `{"error": {"code": "<stable code>", "message":
    "<human-readable text>"}}`. The statuses listed on each operation (400,
    401, 403, 404, 429) are the outcomes a client handles explicitly. A 400
    is either `invalid_argument` (a malformed request) or `too_much_data`: the
    request produces more data than can be served in one response, and only a
    narrower window fixes it - it is never a rate limit. In
    addition, any operation can answer 502 (`bad_gateway`), 503
    (`unavailable`) or 504 (`deadline_exceeded`) while the gateway or an
    upstream is unavailable or slow; these are transient - retry with
    exponential backoff.
servers:
  - url: https://public-api.takeprofit.com
    description: Production
security: []
paths:
  /api/v1/marketdata/footprint/row-size-scale:
    get:
      tags:
        - Footprint
      summary: Get the volume footprint row size scale
      description: >
        The row size scale a settings UI can offer for one security and
        timeframe, in absolute

        quote-currency units - the units `rowSizeValue` and every profile's
        `rowSize` speak, so

        scale values can be echoed back directly: the step every achievable row
        size is a

        multiple of, and the bounds it stays within.


        - Measured over the most recent profile periods (a server-configured
        count, by default
          100), ending at the security's newest stored candle - the window a chart opens on.
        - A `rowSizeValue` that is a whole multiple of the step within
        `[minRowSize, maxRowSize]`
          is answered verbatim by requests over that recent window. History deeper than it can be
          stored more coarsely, so a request reaching far back may resolve a coarser grid, which
          the response and stream report and the echoed `rowSizeValue` follows.
        - The step follows how coarsely the stored data of the timeframe is
        packed, so it differs
          between timeframes and securities and can grow over time - re-read it with the chart
          rather than caching it.
        - 404 (`exchange not found`) when the exchange is not served; 404 with
        the generic
          `requested resource was not found` when the security is not served or the window
          holds no stored data - unlike the profile endpoints, this one cannot tell the two apart.

        **Cost:** 1000 credits per request (flat).
      operationId: getFootprintRowSizeScale
      parameters:
        - name: exchange
          in: query
          required: true
          schema:
            $ref: '#/components/schemas/ExchangeCode'
        - name: symbol
          in: query
          required: true
          description: >-
            Public security symbol returned by
            /api/v1/marketdata/exchanges/{exchange}/securities.
          schema:
            $ref: '#/components/schemas/SecuritySymbol'
        - name: timeframe
          in: query
          required: true
          description: >-
            Minute (1m..59m), hour (1h..24h), day (1d..31d), week (1w..4w), or
            month (1M) timeframe id.
          schema:
            $ref: '#/components/schemas/TimeframeId'
        - name: sessionType
          in: query
          required: false
          description: >-
            Optional session filter. Repeat this parameter or pass
            comma-separated values.
          style: form
          explode: true
          schema:
            type: array
            items:
              $ref: '#/components/schemas/SessionType'
      responses:
        '200':
          description: Volume footprint row size scale response.
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FootprintRowSizeScaleResponse'
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/ScaleNotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    ExchangeCode:
      type: string
      description: TakeProfit exchange code as returned by /api/v1/marketdata/exchanges.
      example: BATS
    SecuritySymbol:
      type: string
      description: >-
        TakeProfit security symbol as returned by
        /api/v1/marketdata/exchanges/{exchange}/securities. In a path segment a
        slash must be percent-encoded (BTC/USDT is requested as BTC%2FUSDT).
      example: AAPL
    TimeframeId:
      type: string
      description: >-
        Timeframe id returned by /api/v1/marketdata/timeframes. Canonical
        suffixes include M for months and Q for quarters.
      example: 1h
    SessionType:
      type: string
      enum:
        - MAINSESSION
        - PRE_MARKET
        - POST_MARKET
    FootprintRowSizeScaleResponse:
      type: object
      required:
        - meta
        - rowSizeStep
        - minRowSize
        - maxRowSize
      example:
        meta:
          exchange: CXBNCE
          symbol: BTC/USDT
          timeframe: 1h
        rowSizeStep: '100'
        minRowSize: '100'
        maxRowSize: '2600'
      properties:
        meta:
          $ref: '#/components/schemas/CandlesMeta'
        rowSizeStep:
          type: string
          description: >-
            The quantum of the scale, in quote currency units. A rowSizeValue
            that is a whole multiple of this within [minRowSize, maxRowSize]
            comes back verbatim. The least common grid of the security's tick
            size and the coarsest stored price grid of the measured window;
            divided by the tick size it is always a whole number of ticks.
        minRowSize:
          type: string
          description: >-
            The smallest row size a request is answered with; anything below
            comes back as this. Equal to rowSizeStep unless the per-profile row
            limit binds on the widest profile period of the window.
        maxRowSize:
          type: string
          description: >-
            Advisory upper end of the scale: the widest profile period's price
            range on the step grid. Larger values are served but render every
            profile as a single row.
    CandlesMeta:
      type: object
      required:
        - exchange
        - symbol
        - timeframe
      properties:
        exchange:
          $ref: '#/components/schemas/ExchangeCode'
        symbol:
          $ref: '#/components/schemas/SecuritySymbol'
        timeframe:
          $ref: '#/components/schemas/TimeframeId'
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: Stable public error code.
            message:
              type: string
              description: Human-readable public error message.
      example:
        error:
          code: unauthenticated
          message: authentication failed
  headers:
    RateLimitLimit:
      description: Credits allowed per quota window.
      schema:
        type: integer
    RateLimitRemaining:
      description: Credits still available in the current quota window after this request.
      schema:
        type: integer
    RateLimitReset:
      description: Epoch second at which the current quota window resets.
      schema:
        type: integer
        format: int64
    RetryAfter:
      description: Seconds until the quota window resets and the request can be retried.
      schema:
        type: integer
  responses:
    InvalidRequest:
      description: >-
        Invalid request (`invalid_argument`), or a request producing more data
        than can be served (`too_much_data`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: invalid_argument
              message: query parameter "exchange" is required
    Unauthorized:
      description: Authentication failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: unauthenticated
              message: authentication failed
    Forbidden:
      description: Permission denied.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: permission_denied
              message: permission denied
    ScaleNotFound:
      description: >-
        The exchange is not served, or the security is not served or the window
        holds no stored data (the two are indistinguishable here).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: not_found
              message: requested resource was not found
    RateLimited:
      description: >-
        The remaining credits of the quota window cannot cover this request;
        retry after the window resets.
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: rate_limited
              message: rate limit exceeded
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````