Interface ApiManagementApiInterface

ApiManagementApi - interface ApiManagementApi

interface ApiManagementApiInterface {
    addIpRestrictionForSubAccountApiKey(
        requestParameters: AddIpRestrictionForSubAccountApiKeyRequest,
    ): Promise<RestApiResponse<AddIpRestrictionForSubAccountApiKeyResponse>>;
    createSubAccountApiKey(
        requestParameters: CreateSubAccountApiKeyRequest,
    ): Promise<RestApiResponse<CreateSubAccountApiKeyResponse>>;
    deleteIpListForASubAccountApiKey(
        requestParameters: DeleteIpListForASubAccountApiKeyRequest,
    ): Promise<RestApiResponse<DeleteIpListForASubAccountApiKeyResponse>>;
    deleteSubAccountApiKey(
        requestParameters: DeleteSubAccountApiKeyRequest,
    ): Promise<RestApiResponse<object>>;
    getIpRestrictionForASubAccountApiKey(
        requestParameters: GetIpRestrictionForASubAccountApiKeyRequest,
    ): Promise<RestApiResponse<GetIpRestrictionForASubAccountApiKeyResponse>>;
    modifySubAccountApiKeyPermission(
        requestParameters: ModifySubAccountApiKeyPermissionRequest,
    ): Promise<RestApiResponse<ModifySubAccountApiKeyPermissionResponse>>;
    querySubAccountApiKey(
        requestParameters: QuerySubAccountApiKeyRequest,
    ): Promise<RestApiResponse<QuerySubAccountApiKeyResponse>>;
}

Implemented by

ApiManagementApi

Index

Methods

addIpRestrictionForSubAccountApiKey createSubAccountApiKey deleteIpListForASubAccountApiKey deleteSubAccountApiKey getIpRestrictionForASubAccountApiKey modifySubAccountApiKeyPermission querySubAccountApiKey

Methods

addIpRestrictionForSubAccountApiKey

addIpRestrictionForSubAccountApiKey(
requestParameters: AddIpRestrictionForSubAccountApiKeyRequest,
): Promise<RestApiResponse<AddIpRestrictionForSubAccountApiKeyResponse>>
Add IP Restriction for Sub-Account API key

Weight(UID): 3000

Security Type: USER_DATA

Notes:
- You need to enable Enable Spot & Margin Trading option for the api key which requests this endpoint
Parameters
- requestParameters: AddIpRestrictionForSubAccountApiKeyRequest
  Request parameters.
Returns Promise<RestApiResponse<AddIpRestrictionForSubAccountApiKeyResponse>>
Throws
Memberof
ApiManagementApiInterface
- Defined in clients/sub-account/src/rest-api/modules/api-management-api.ts:545

createSubAccountApiKey

createSubAccountApiKey(
requestParameters: CreateSubAccountApiKeyRequest,
): Promise<RestApiResponse<CreateSubAccountApiKeyResponse>>
Create a new API Key for a sub-account.

Weight(UID): 3000

Security Type: USER_DATA

Notes:
- status=2 requires ipAddress
- status=3 requires thirdPartyName
- Asset Sub Account is not supported
- The caller must pass the KYC IP restriction check
Parameters
- requestParameters: CreateSubAccountApiKeyRequest
  Request parameters.
Returns Promise<RestApiResponse<CreateSubAccountApiKeyResponse>>
Throws
Memberof
ApiManagementApiInterface
- Defined in clients/sub-account/src/rest-api/modules/api-management-api.ts:567

deleteIpListForASubAccountApiKey

deleteIpListForASubAccountApiKey(
requestParameters: DeleteIpListForASubAccountApiKeyRequest,
): Promise<RestApiResponse<DeleteIpListForASubAccountApiKeyResponse>>
Delete IP List For a Sub-account API Key

Weight(UID): 3000

Security Type: USER_DATA

Notes:
- You need to enable Enable Spot & Margin Trading option for the api key which requests this endpoint
Parameters
- requestParameters: DeleteIpListForASubAccountApiKeyRequest
  Request parameters.
Returns Promise<RestApiResponse<DeleteIpListForASubAccountApiKeyResponse>>
Throws
Memberof
ApiManagementApiInterface
- Defined in clients/sub-account/src/rest-api/modules/api-management-api.ts:586

deleteSubAccountApiKey

deleteSubAccountApiKey(
requestParameters: DeleteSubAccountApiKeyRequest,
): Promise<RestApiResponse<object>>
Delete an API Key of a sub-account.

Weight(UID): 3000

Security Type: USER_DATA

Notes:
- Asset Sub Account is not supported
- The caller must pass the KYC IP restriction check
Parameters
- requestParameters: DeleteSubAccountApiKeyRequest
  Request parameters.
Returns Promise<RestApiResponse<object>>
Throws
Memberof
ApiManagementApiInterface
- Defined in clients/sub-account/src/rest-api/modules/api-management-api.ts:606

getIpRestrictionForASubAccountApiKey

getIpRestrictionForASubAccountApiKey(
requestParameters: GetIpRestrictionForASubAccountApiKeyRequest,
): Promise<RestApiResponse<GetIpRestrictionForASubAccountApiKeyResponse>>
Get IP Restriction for a Sub-account API Key

Weight(UID): 3000

Security Type: USER_DATA
Parameters
- requestParameters: GetIpRestrictionForASubAccountApiKeyRequest
  Request parameters.
Returns Promise<RestApiResponse<GetIpRestrictionForASubAccountApiKeyResponse>>
Throws
Memberof
ApiManagementApiInterface
- Defined in clients/sub-account/src/rest-api/modules/api-management-api.ts:622

modifySubAccountApiKeyPermission

modifySubAccountApiKeyPermission(
requestParameters: ModifySubAccountApiKeyPermissionRequest,
): Promise<RestApiResponse<ModifySubAccountApiKeyPermissionResponse>>
Modify the trading permissions of a sub-account API Key.

Weight(UID): 3000

Security Type: USER_DATA

Notes:
- Portfolio Margin Retail User is not supported
- Asset Sub Account is not supported
- The caller must pass the KYC IP restriction check
Parameters
- requestParameters: ModifySubAccountApiKeyPermissionRequest
  Request parameters.
Returns Promise<RestApiResponse<ModifySubAccountApiKeyPermissionResponse>>
Throws
Memberof
ApiManagementApiInterface
- Defined in clients/sub-account/src/rest-api/modules/api-management-api.ts:643

querySubAccountApiKey

querySubAccountApiKey(
requestParameters: QuerySubAccountApiKeyRequest,
): Promise<RestApiResponse<QuerySubAccountApiKeyResponse>>
Query the API Key list of a sub-account.

Weight(UID): 3000

Security Type: USER_DATA
Parameters
- requestParameters: QuerySubAccountApiKeyRequest
  Request parameters.
Returns Promise<RestApiResponse<QuerySubAccountApiKeyResponse>>
Throws
Memberof
ApiManagementApiInterface
- Defined in clients/sub-account/src/rest-api/modules/api-management-api.ts:659

Interface ApiManagementApiInterface

Implemented by

Index

Methods

Methods

addIpRestrictionForSubAccountApiKey

Parameters

Returns Promise<RestApiResponse<AddIpRestrictionForSubAccountApiKeyResponse>>

Throws

Memberof

createSubAccountApiKey

Parameters

Returns Promise<RestApiResponse<CreateSubAccountApiKeyResponse>>

Throws

Memberof

deleteIpListForASubAccountApiKey

Parameters

Returns Promise<RestApiResponse<DeleteIpListForASubAccountApiKeyResponse>>

Throws

Memberof

deleteSubAccountApiKey

Parameters

Returns Promise<RestApiResponse<object>>

Throws

Memberof

getIpRestrictionForASubAccountApiKey

Parameters

Returns Promise<RestApiResponse<GetIpRestrictionForASubAccountApiKeyResponse>>

Throws

Memberof

modifySubAccountApiKeyPermission

Parameters

Returns Promise<RestApiResponse<ModifySubAccountApiKeyPermissionResponse>>

Throws

Memberof

querySubAccountApiKey

Parameters

Returns Promise<RestApiResponse<QuerySubAccountApiKeyResponse>>

Throws

Memberof

Settings

On This Page