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

# Get velocity control

> Get details about a velocity control.

export const EndpointPath = ({type, path}) => {
  return <div class="flex w-full flex-col bg-background-light dark:bg-background-dark border-standard rounded-2xl p-1.5">
      <div class="flex items-center space-x-1.5">
        <div class="relative flex-1 flex gap-2 min-w-0 rounded-xl items-center cursor-pointer p-1.5 border-standard">
          <div class="rounded-lg font-bold px-1.5 py-0.5 text-sm leading-5 bg-blue-400/20 dark:bg-blue-400/20 text-blue-700 dark:text-blue-400">
            POST
          </div>
          <div class="flex items-center space-x-2 overflow-x-auto flex-1 no-scrollbar">
            <div class="group flex items-center flex-1 gap-0.5 font-mono">
              <div class="absolute right-0 p-2 bg-background-light dark:bg-background-dark rounded-lg hidden group-hover:block">
                <svg class="w-4 h-4 bg-gray-400 dark:bg-white/30"></svg>
              </div>
              <div class="text-sm text-gray-400">/</div>
              <div class="text-sm font-medium text-gray-800 dark:text-white min-w-max">
                public
              </div>
              <div class="text-sm text-gray-400">/</div>
              <div class="text-sm font-medium text-gray-800 dark:text-white min-w-max">
                v1
              </div>
              <div class="text-sm text-gray-400">/</div>
              <div class="text-sm font-medium text-gray-800 dark:text-white min-w-max">
                {type}
              </div>
              <div class="text-sm text-gray-400">/</div>
              <div class="text-sm font-medium text-gray-800 dark:text-white min-w-max">
                {path}
              </div>
            </div>
          </div>
        </div>
      </div>
    </div>;
};

export const NestedParam = ({parentKey, childKey, type, required, description, children}) => {
  const fullKey = `${parentKey}.${childKey}`;
  const anchorId = `body-${fullKey.replace(/\./g, '-')}`;
  return <div className="py-6 border-gray-100 dark:border-gray-800 border-b last:border-b-0">
  <div className="flex font-mono text-sm group/param-head param-head break-all relative" id={anchorId}>
    <div className="flex-1 flex content-start py-0.5 mr-5">
      <div className="flex items-center flex-wrap gap-2">
        <div className="absolute -top-1.5">
          <a href={`#${anchorId}`} className="-ml-[2.1rem] flex items-center opacity-0 border-0 group-hover/param-head:opacity-100 py-2 [.expandable-content_&]:-ml-[2.1rem]" aria-label="Navigate to header">
            <div className="w-6 h-6 text-gray-400 rounded-md flex items-center justify-center zinc-box bg-white ring-1 ring-gray-400/30 dark:ring-gray-700/25 hover:ring-gray-400/60 dark:hover:ring-white/20">
              <svg xmlns="http://www.w3.org/2000/svg" fill="gray" height="12px" viewBox="0 0 576 512">
                <path d="M0 256C0 167.6 71.6 96 160 96h72c13.3 0 24 10.7 24 24s-10.7 24-24 24H160C98.1 144 48 194.1 48 256s50.1 112 112 112h72c13.3 0 24 10.7 24 24s-10.7 24-24 24H160C71.6 416 0 344.4 0 256zm576 0c0 88.4-71.6 160-160 160H344c-13.3 0-24-10.7-24-24s10.7-24 24-24h72c61.9 0 112-50.1 112-112s-50.1-112-112-112H344c-13.3 0-24-10.7-24-24s10.7-24 24-24h72c88.4 0 160 71.6 160 160zM184 232H392c13.3 0 24 10.7 24 24s-10.7 24-24 24H184c-13.3 0-24-10.7-24-24s10.7-24 24-24z"></path>
              </svg>
            </div>
          </a>
        </div>
        <div className="font-semibold text-primary dark:text-primary-light cursor-pointer overflow-wrap-anywhere">
          <span className="text-gray-500 dark:text-gray-400">{parentKey}.</span>
          {childKey}
        </div>
        <div className="inline items-center gap-2 text-xs font-medium [&_div]:inline [&_div]:mr-2 [&_div]:leading-5">
          <div className="flex items-center px-2 py-0.5 rounded-md bg-gray-100/50 dark:bg-white/5 text-gray-600 dark:text-gray-200 font-medium break-all">
            <span>{type}</span>
          </div>
          {required && <span className="px-2 py-0.5 rounded-md bg-red-100/50 dark:bg-red-400/10 text-red-600 dark:text-red-300 font-medium whitespace-nowrap">
              required
            </span>}
        </div>
      </div>
    </div>
  </div>
  {children && <div className="mt-4">
      <div className="prose prose-sm prose-gray dark:prose-invert">
        {children}
      </div>
    </div>}
</div>;
};

export const H3Bordered = ({text}) => <h3 id={text.toLowerCase()} className="border-b pb-2.5 border-gray-100 dark:border-gray-800">
    {text}
  </h3>;

export const Authorizations = () => {
  return <div>
      <H3Bordered text="Authorizations" />

      <Tabs>
        <Tab title="API Key">
          <div className="flex text-sm group/param-head param-head break-all relative" id="authorization-x-stamp">
            <ParamField header="X-Stamp" type="string" required={true}>
              Cryptographically signed (stamped) request to be passed in as a header. For more info, see <a href="https://docs.turnkey.com/developer-reference/api-overview/stamps">here</a>.
            </ParamField>
          </div>
        </Tab>

        <Tab title="WebAuthn (Passkey)">
         <div className="flex text-sm group/param-head param-head break-all relative" id="authorization-x-stamp-webauthn">
            <ParamField body="X-Stamp-WebAuthn" type="string" required={true}>
              Cryptographically signed (stamped) request to be passed in as a header. For more info, see <a href="https://docs.turnkey.com/developer-reference/api-overview/stamps">here</a>.
            </ParamField>
          </div>
        </Tab>
      </Tabs>
    </div>;
};

<EndpointPath type="query" path="get_velocity_control" />

<Authorizations />

<H3Bordered text="Body" />

<ParamField body="organizationId" type="string" required={true}>
  organizationId field
</ParamField>

<ParamField body="velocityControlId" type="string" required={true}>
  velocityControlId field
</ParamField>

<H3Bordered text="Response" />

A successful response returns the following fields:

<ResponseField name="velocityControl" type="object" required={true}>
  velocityControl field

  <Expandable title="velocityControl details">
    <NestedParam parentKey="velocityControl" childKey="velocityControlId" type="string" required={true}>
      Unique identifier for the Velocity Control.
    </NestedParam>

    <NestedParam parentKey="velocityControl" childKey="organizationId" type="string" required={true}>
      Identifier of the Organization that owns the Velocity Control.
    </NestedParam>

    <NestedParam parentKey="velocityControl" childKey="name" type="string" required={true}>
      Human-readable name for the Velocity Control.
    </NestedParam>

    <NestedParam parentKey="velocityControl" childKey="dataSource" type="object" required={true}>
      dataSource field

      <Expandable title="dataSource details">
        <NestedParam parentKey="velocityControl.dataSource" childKey="chainAssetTransfer" type="object" required={false}>
          chainAssetTransfer field

          <Expandable title="chainAssetTransfer details">
            <NestedParam parentKey="velocityControl.dataSource.chainAssetTransfer" childKey="definition" type="array" required={true}>
              Assets whose transfers are included in the data source.

              <Expandable title="definition details">
                <NestedParam parentKey="velocityControl.dataSource.chainAssetTransfer.definition" childKey="caip19" type="string" required={true}>
                  CAIP-19 identifier for the asset.
                </NestedParam>

                <NestedParam parentKey="velocityControl.dataSource.chainAssetTransfer.definition" childKey="decimals" type="string" required={true}>
                  Base-10 integer string from 0 through 255 that specifies the number of decimal places for the asset.
                </NestedParam>
              </Expandable>
            </NestedParam>

            <NestedParam parentKey="velocityControl.dataSource.chainAssetTransfer" childKey="filter" type="object" required={false}>
              filter field

              <Expandable title="filter details">
                <NestedParam parentKey="velocityControl.dataSource.chainAssetTransfer.filter" childKey="activity" type="array" required={false}>
                  Activity types whose asset transfers are included.

                  <Expandable title="activity details">
                    <NestedParam parentKey="velocityControl.dataSource.chainAssetTransfer.filter.activity" childKey="activityType" type="string" required={true}>
                      Name of an activity type to include, such as `ACTIVITY_TYPE_SOL_SEND_TRANSACTION`.
                    </NestedParam>
                  </Expandable>
                </NestedParam>
              </Expandable>
            </NestedParam>

            <NestedParam parentKey="velocityControl.dataSource.chainAssetTransfer" childKey="phase" type="object" required={false}>
              phase field

              <Expandable title="phase details">
                <NestedParam parentKey="velocityControl.dataSource.chainAssetTransfer.phase" childKey="signature" type="object" required={false}>
                  signature field
                </NestedParam>

                <NestedParam parentKey="velocityControl.dataSource.chainAssetTransfer.phase" childKey="submission" type="object" required={false}>
                  submission field
                </NestedParam>
              </Expandable>
            </NestedParam>
          </Expandable>
        </NestedParam>

        <NestedParam parentKey="velocityControl.dataSource" childKey="activityExecution" type="object" required={false}>
          activityExecution field

          <Expandable title="activityExecution details">
            <NestedParam parentKey="velocityControl.dataSource.activityExecution" childKey="filter" type="object" required={false}>
              filter field

              <Expandable title="filter details">
                <NestedParam parentKey="velocityControl.dataSource.activityExecution.filter" childKey="activity" type="array" required={false}>
                  Activity types whose executions are included.

                  <Expandable title="activity details">
                    <NestedParam parentKey="velocityControl.dataSource.activityExecution.filter.activity" childKey="activityType" type="string" required={true}>
                      Name of an activity type to include, such as `ACTIVITY_TYPE_SOL_SEND_TRANSACTION`.
                    </NestedParam>
                  </Expandable>
                </NestedParam>
              </Expandable>
            </NestedParam>
          </Expandable>
        </NestedParam>
      </Expandable>
    </NestedParam>

    <NestedParam parentKey="velocityControl" childKey="aggregation" type="object" required={true}>
      aggregation field

      <Expandable title="aggregation details">
        <NestedParam parentKey="velocityControl.aggregation" childKey="method" type="enum" required={true}>
          method field

          Enum options: `VELOCITY_CONTROL_AGGREGATION_METHOD_SUM`, `VELOCITY_CONTROL_AGGREGATION_METHOD_COUNT`
        </NestedParam>

        <NestedParam parentKey="velocityControl.aggregation" childKey="operator" type="enum" required={true}>
          operator field

          Enum options: `VELOCITY_CONTROL_AGGREGATION_OPERATOR_LESS_THAN`, `VELOCITY_CONTROL_AGGREGATION_OPERATOR_LESS_THAN_OR_EQUAL`, `VELOCITY_CONTROL_AGGREGATION_OPERATOR_EQUAL`, `VELOCITY_CONTROL_AGGREGATION_OPERATOR_GREATER_THAN_OR_EQUAL`, `VELOCITY_CONTROL_AGGREGATION_OPERATOR_GREATER_THAN`
        </NestedParam>

        <NestedParam parentKey="velocityControl.aggregation" childKey="threshold" type="string" required={true}>
          Non-negative base-10 decimal string with at most 38 total digits and 18 fractional digits.
        </NestedParam>

        <NestedParam parentKey="velocityControl.aggregation" childKey="window" type="object" required={true}>
          window field

          <Expandable title="window details">
            <NestedParam parentKey="velocityControl.aggregation.window" childKey="rolling" type="object" required={false}>
              rolling field

              <Expandable title="rolling details">
                <NestedParam parentKey="velocityControl.aggregation.window.rolling" childKey="duration" type="string" required={true}>
                  Duration of the rolling window, in seconds, as a base-10 integer string.
                </NestedParam>
              </Expandable>
            </NestedParam>

            <NestedParam parentKey="velocityControl.aggregation.window" childKey="infinite" type="object" required={false}>
              infinite field
            </NestedParam>
          </Expandable>
        </NestedParam>

        <NestedParam parentKey="velocityControl.aggregation" childKey="groupBy" type="object" required={true}>
          groupBy field

          <Expandable title="groupBy details">
            <NestedParam parentKey="velocityControl.aggregation.groupBy" childKey="organization" type="object" required={false}>
              organization field
            </NestedParam>

            <NestedParam parentKey="velocityControl.aggregation.groupBy" childKey="user" type="object" required={false}>
              user field
            </NestedParam>

            <NestedParam parentKey="velocityControl.aggregation.groupBy" childKey="wallet" type="object" required={false}>
              wallet field
            </NestedParam>
          </Expandable>
        </NestedParam>
      </Expandable>
    </NestedParam>

    <NestedParam parentKey="velocityControl" childKey="createdAt" type="object" required={true}>
      createdAt field

      <Expandable title="createdAt details">
        <NestedParam parentKey="velocityControl.createdAt" childKey="seconds" type="string" required={true}>
          seconds field
        </NestedParam>

        <NestedParam parentKey="velocityControl.createdAt" childKey="nanos" type="string" required={true}>
          nanos field
        </NestedParam>
      </Expandable>
    </NestedParam>

    <NestedParam parentKey="velocityControl" childKey="updatedAt" type="object" required={true}>
      updatedAt field

      <Expandable title="updatedAt details">
        <NestedParam parentKey="velocityControl.updatedAt" childKey="seconds" type="string" required={true}>
          seconds field
        </NestedParam>

        <NestedParam parentKey="velocityControl.updatedAt" childKey="nanos" type="string" required={true}>
          nanos field
        </NestedParam>
      </Expandable>
    </NestedParam>

    <NestedParam parentKey="velocityControl" childKey="identifier" type="string" required={true}>
      Identifier for the Velocity Control. Policies reference it as `controls.<identifier>`. It must be unique within the Organization.
    </NestedParam>
  </Expandable>
</ResponseField>

<RequestExample>
  ```bash title="cURL" theme={"system"}
  curl --request POST \
    --url https://api.turnkey.com/public/v1/query/get_velocity_control \
    --header 'Accept: application/json' \
    --header 'Content-Type: application/json' \
    --header "X-Stamp: <string> (see Authorizations)" \
    --data '{
      "organizationId": "<string>",
      "velocityControlId": "<string>"
  }'
  ```

  ```javascript title="JavaScript" theme={"system"}
  import { Turnkey } from "@turnkey/sdk-server";

  const turnkeyClient = new Turnkey({
    apiBaseUrl: "https://api.turnkey.com",
    apiPublicKey: process.env.API_PUBLIC_KEY!,
    apiPrivateKey: process.env.API_PRIVATE_KEY!,
    defaultOrganizationId: process.env.ORGANIZATION_ID!,
  });

  const response = await turnkeyClient.apiClient().getVelocityControl({
    organizationId: "<string> (organizationId field)",
    velocityControlId: "<string> (velocityControlId field)"
  });
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={"system"}
  {
    "velocityControl": {
      "velocityControlId": "<string>",
      "organizationId": "<string>",
      "name": "<string>",
      "dataSource": {
        "chainAssetTransfer": {
          "definition": [
            {
              "caip19": "<string>",
              "decimals": "<string>"
            }
          ],
          "filter": {
            "activity": [
              {
                "activityType": "<string>"
              }
            ]
          },
          "phase": {
            "signature": "<object>",
            "submission": "<object>"
          }
        },
        "activityExecution": {
          "filter": {
            "activity": [
              {
                "activityType": "<string>"
              }
            ]
          }
        }
      },
      "aggregation": {
        "method": "<VELOCITY_CONTROL_AGGREGATION_METHOD_SUM>",
        "operator": "<VELOCITY_CONTROL_AGGREGATION_OPERATOR_LESS_THAN>",
        "threshold": "<string>",
        "window": {
          "rolling": {
            "duration": "<string>"
          },
          "infinite": "<object>"
        },
        "groupBy": {
          "organization": "<object>",
          "user": "<object>",
          "wallet": "<object>"
        }
      },
      "createdAt": {
        "seconds": "<string>",
        "nanos": "<string>"
      },
      "updatedAt": {
        "seconds": "<string>",
        "nanos": "<string>"
      },
      "identifier": "<string>"
    }
  }
  ```
</ResponseExample>