find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/anthid-com:anthid-com-account-time-controls-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Account Time Controls API
  description: Account-level time-window control configuration
  license:
    name: ''
  version: 0.1.0
servers:
- url: https://api.anthid.com
  description: Production
tags:
- name: Account Time Controls
  description: Account-level time-window control configuration
paths:
  /v1/controls/accounts/{account_id}/time:
    get:
      tags:
      - Account Time Controls
      summary: Get account time control
      description: Returns time-window controls for a trading account. Users and API keys require Controls Basic or Premium and control read access. Services need `control:read` and `x-organization-id`. The organization must own the account.
      operationId: getAccountTimeControl
      parameters:
      - name: account_id
        in: path
        description: Trading account ID
        required: true
        schema:
          type: string
          format: uuid
        example: 550e8400-e29b-41d4-a716-446655440000
      - name: x-organization-id
        in: header
        description: Organization id required when reading with service-account credentials
        required: false
        schema:
          type:
          - string
          - 'null'
          format: uuid
      responses:
        '200':
          description: Account time control found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountTimeControl'
              example:
                account_id: 550e8400-e29b-41d4-a716-446655440000
                created_at: '2026-08-12T16:20:00Z'
                organization_id: 550e8400-e29b-41d4-a716-446655440222
                stale_order_millis: 30000
                trading_end: '16:00:00'
                trading_start: 09:30:00
                updated_at: '2026-08-12T16:20:00Z'
                version: 1
        '400':
          description: Path or query parameters are invalid, or the service-account `x-organization-id` header is missing or invalid
          content:
            application/json:
              schema:
                type: string
            text/plain:
              schema:
                type: string
        '401':
          description: Missing or invalid authentication credentials
        '403':
          description: Caller lacks controls entitlement or read permission, or the account is missing or owned by another organization
          content:
            application/json:
              schema:
                type: string
        '404':
          description: Account time control was not found
          content:
            application/json:
              schema:
                type: string
        '429':
          description: Caller exceeded the request rate limit
        '500':
          description: Server error
          content:
            application/json:
              schema:
                type: string
      security:
      - bearerAuth: []
      - clientCredentials: []
      - apiKeyAuth: []
    put:
      tags:
      - Account Time Controls
      summary: Upsert account time control
      description: Creates or replaces time-window controls for a trading account in the caller's organization. Omitted optional fields are cleared. Requires Controls Basic or Premium. Users need an organization admin role; API keys need control edit permission for the account's environment.
      operationId: upsertAccountTimeControl
      parameters:
      - name: account_id
        in: path
        description: Trading account ID
        required: true
        schema:
          type: string
          format: uuid
        example: 550e8400-e29b-41d4-a716-446655440000
      requestBody:
        description: Trading window and stale-order timeout settings for the account
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpsertTimeControlRequest'
            example:
              stale_order_millis: 30000
              trading_end: '16:00:00'
              trading_start: 09:30:00
        required: true
      responses:
        '200':
          description: Account time control upserted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountTimeControl'
              example:
                account_id: 550e8400-e29b-41d4-a716-446655440000
                created_at: '2026-08-12T16:20:00Z'
                organization_id: 550e8400-e29b-41d4-a716-446655440222
                stale_order_millis: 30000
                trading_end: '16:00:00'
                trading_start: 09:30:00
                updated_at: '2026-08-12T16:20:00Z'
                version: 1
        '400':
          description: stale_order_millis is not positive, or JSON syntax or path parameters are invalid
          content:
            application/json:
              schema:
                type: string
            text/plain:
              schema:
                type: string
        '401':
          description: Missing or invalid authentication credentials, or missing organization context
          content:
            application/json:
              schema:
                type: string
        '403':
          description: Caller lacks controls entitlement or edit permission, or the account is missing or owned by another organization
          content:
            application/json:
              schema:
                type: string
        '413':
          description: Request body exceeds the size limit
          content:
            text/plain:
              schema:
                type: string
        '415':
          description: Content-Type must be application/json
          content:
            text/plain:
              schema:
                type: string
        '422':
          description: JSON does not match the request schema
          content:
            text/plain:
              schema:
                type: string
        '429':
          description: Caller exceeded the request rate limit
        '500':
          description: Server error
          content:
            application/json:
              schema:
                type: string
      security:
      - bearerAuth: []
      - apiKeyAuth: []
    delete:
      tags:
      - Account Time Controls
      summary: Delete account time control
      description: Deletes time-window controls for a trading account in the caller's organization. Requires Controls Basic or Premium. Users need an organization admin role; API keys need control edit permission for the account's environment.
      operationId: deleteAccountTimeControl
      parameters:
      - name: account_id
        in: path
        description: Trading account ID
        required: true
        schema:
          type: string
          format: uuid
        example: 550e8400-e29b-41d4-a716-446655440000
      responses:
        '200':
          description: Account time control deleted, or was already deleted. `deleted_at` is when it was first removed and does not move on a repeat call.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeletedResponse'
              example:
                deleted: true
                deleted_at: '2026-08-12T16:20:00Z'
                resource: account_time_control
        '400':
          description: Path parameters are invalid
          content:
            application/json:
              schema:
                type: string
            text/plain:
              schema:
                type: string
        '401':
          description: Missing or invalid authentication credentials, or missing organization context
          content:
            application/json:
              schema:
                type: string
        '403':
          description: Caller lacks controls entitlement or edit permission, or the account is missing or owned by another organization
          content:
            application/json:
              schema:
                type: string
        '404':
          description: No control of this kind has ever existed in this scope
          content:
            application/json:
              schema:
                type: string
        '429':
          description: Caller exceeded the request rate limit
        '500':
          description: Server error
          content:
            application/json:
              schema:
                type: string
      security:
      - bearerAuth: []
      - apiKeyAuth: []
    patch:
      tags:
      - Account Time Controls
      summary: Patch account time control
      description: Creates or patches time-window controls for a trading account. Omitted and null fields are unchanged; `clear` removes named fields. Requires Controls Basic or Premium. Users need an organization admin role; API keys need control edit permission for the account's environment.
      operationId: patchAccountTimeControl
      parameters:
      - name: account_id
        in: path
        description: Trading account ID
        required: true
        schema:
          type: string
          format: uuid
        example: 550e8400-e29b-41d4-a716-446655440000
      requestBody:
        description: Fields to change, and fields to remove
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchTimeControlRequest'
            example:
              clear:
              - stale_order_millis
              trading_start: 09:30:00
        required: true
      responses:
        '200':
          description: Account time control patched
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountTimeControl'
              example:
                account_id: 550e8400-e29b-41d4-a716-446655440000
                created_at: '2026-08-12T16:20:00Z'
                organization_id: 550e8400-e29b-41d4-a716-446655440222
                stale_order_millis: null
                trading_end: '16:00:00'
                trading_start: 09:30:00
                updated_at: '2026-08-13T09:15:00Z'
                version: 2
        '400':
          description: No fields changed, or a field is both set and cleared, or stale_order_millis is not positive; malformed JSON or path parameters also fail
          content:
            application/json:
              schema:
                type: string
            text/plain:
              schema:
                type: string
        '401':
          description: Missing or invalid authentication credentials, or missing organization context
          content:
            application/json:
              schema:
                type: string
        '403':
          description: Caller lacks controls entitlement or edit permission, or the account is missing or owned by another organization
          content:
            application/json:
              schema:
                type: string
        '413':
          description: Request body exceeds the size limit
          content:
            text/plain:
              schema:
                type: string
        '415':
          description: Content-Type must be application/json
          content:
            text/plain:
              schema:
                type: string
        '422':
          description: JSON does not match the request schema
          content:
            text/plain:
              schema:
                type: string
        '429':
          description: Caller exceeded the request rate limit
        '500':
          description: Server error
          content:
            application/json:
              schema:
                type: string
      security:
      - bearerAuth: []
      - apiKeyAuth: []
components:
  schemas:
    AccountTimeControl:
      type: object
      required:
      - account_id
      - organization_id
      - version
      - created_at
      - updated_at
      properties:
        account_id:
          type: string
          format: uuid
        created_at:
          type: string
          format: date-time
        organization_id:
          type: string
          format: uuid
        stale_order_millis:
          type:
          - integer
          - 'null'
          format: int64
        trading_end:
          type:
          - string
          - 'null'
        trading_start:
          type:
          - string
          - 'null'
        updated_at:
          type: string
          format: date-time
        version:
          type: integer
          format: int64
    PatchTimeControlRequest:
      type: object
      properties:
        clear:
          type: array
          items:
            $ref: '#/components/schemas/TimeControlField'
        stale_order_millis:
          type:
          - integer
          - 'null'
          format: int64
        trading_end:
          type:
          - string
          - 'null'
        trading_start:
          type:
          - string
          - 'null'
    DeletedResourceKind:
      type: string
      description: 'The resource a delete acted on.


        Named rather than free text so a caller can branch on it, and so the same

        vocabulary is available when these deletes start emitting events.'
      enum:
      - trading_account
      - test_trading_account
      - broker_credential
      - oauth_client
      - organization
      - user
      - organization_control
      - account_control
      - account_risk_control
      - account_time_control
      - symbol_control
      - symbol_risk_control
      - symbol_time_control
    DeletedResponse:
      type: object
      description: 'The body every successful delete returns.


        Deletes are idempotent, so a caller that retries one it is unsure landed

        gets the same 200 as the caller that deleted it. That leaves the caller

        unable to tell the two apart from the status alone, which is what

        `deleted_at` is for: it is the moment the resource was *first* deleted and

        does not move on a repeat call.'
      required:
      - deleted
      - resource
      - deleted_at
      properties:
        deleted:
          type: boolean
          description: 'Always true. A caller checking one field to confirm the outcome does not

            have to special-case which endpoint it called.'
        deleted_at:
          type: string
          format: date-time
          description: When the resource was first deleted, not when this call was made.
        id:
          type:
          - string
          - 'null'
          description: 'Absent for resources keyed by a natural composite key rather than a

            single identifier, which today is every control in the controls service.

            The path already identifies those, so nothing is lost by omitting it.'
        resource:
          $ref: '#/components/schemas/DeletedResourceKind'
    UpsertTimeControlRequest:
      type: object
      properties:
        stale_order_millis:
          type:
          - integer
          - 'null'
          format: int64
        trading_end:
          type:
          - string
          - 'null'
        trading_start:
          type:
          - string
          - 'null'
    TimeControlField:
      type: string
      description: Fields of a time control a PATCH may remove.
      enum:
      - trading_start
      - trading_end
      - stale_order_millis
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    clientCredentials:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Machine bearer token minted via the client_credentials grant.
x-tagGroups:
- name: Organization
  tags:
  - Organization Controls
- name: Account
  tags:
  - Account Manual Controls
  - Account Risk Controls
  - Account Time Controls
- name: Symbols
  tags:
  - Symbol Manual Controls
  - Symbol Risk Controls
  - Symbol Time Controls
  - Effective Controls
- name: Evaluation
  tags:
  - Control Evaluation