Class ProfileAPI

constructor

• new ProfileAPI(apiClient): ProfileAPI

• Parameters

  • apiClient: AxiosInstance

  Returns ProfileAPI

Static ReadonlyURL

getProfile

• getProfile(profileId): Promise<null | Profile>

• Get a single profile by profile ID. This endpoint requires the “view” permission and is accessible by any profile’s API key.

  Parameters

  • profileId: string

    Profile ID

  Returns Promise<null | Profile>

  A single profile

  See

  https://docs.cloud.coinbase.com/exchange/reference/exchangerestapi_getprofile

listProfiles

• listProfiles(active?): Promise<Profile[]>

• List your profiles. Profiles are equivalent to portfolios. This endpoint requires the “view” permission and is accessible by any profile’s API key.

  Parameters

  • Optionalactive: true

    Only return active profiles if set true

  Returns Promise<Profile[]>

  See

  https://docs.cloud.coinbase.com/exchange/reference/exchangerestapi_getprofiles

transferFunds

• transferFunds(transfer): Promise<void>

• Transfer funds from API key’s profile to another user owned profile. This endpoint requires the “transfer” permission.

  Parameters

  • transfer: FundTransfer

  Returns Promise<void>

  See

  https://docs.cloud.coinbase.com/exchange/reference/exchangerestapi_postprofiletransfer