# getRlStatesFiltered · FT4 TypeScript client · Chromia Docs (concept)

> getRlStatesFiltered(
    connection: Connection ,
    rlStateFilter?: RlStateFilter ,
    limit?: OptionalLimit ,
    cursor?: OptionalPageCursor ,
): Prom

Source: https://docs.chromia.com/pages/ft4-ts-client/functions/accounts.getRlStatesFiltered/

Function

# getRlStatesFiltered

* ```signature
  getRlStatesFiltered(
      connection: Connection,
      rlStateFilter?: RlStateFilter,
      limit?: OptionalLimit,
      cursor?: OptionalPageCursor,
  ): Promise<PaginatedEntity<RlState>>
  ```

  Retrieves a paginated list of rate limit states filtered by the specified criteria.

  #### Parameters

  + connection: [Connection](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/)

    The database connection to use for the query.
  + rlStateFilter: [RlStateFilter](https://docs.chromia.com/pages/ft4-ts-client/types/accounts.RlStateFilter/) = null

    The filter criteria for rate limit states. Defaults to null.
  + limit: [OptionalLimit](https://docs.chromia.com/pages/ft4-ts-client/types/ft-session.OptionalLimit/) = null

    The maximum number of results to return. Defaults to null.
  + cursor: [OptionalPageCursor](https://docs.chromia.com/pages/ft4-ts-client/types/ft-session.OptionalPageCursor/) = null

    The cursor for pagination. Defaults to null.

  #### Returns Promise<[PaginatedEntity](https://docs.chromia.com/pages/ft4-ts-client/types/utils.PaginatedEntity/)<[RlState](https://docs.chromia.com/pages/ft4-ts-client/types/accounts.RlState/)>>

  A promise that resolves to a paginated entity containing the filtered rate limit states.

  Available since ApiVersion 1

[View this page on docs.chromia.com](https://docs.chromia.com/pages/ft4-ts-client/functions/accounts.getRlStatesFiltered.html)Generated API reference, mirrored from the live docs