Get Account By ID

client.V1.Accounts.GetAccountByID(ctx, accountID) (*V1AccountGetAccountByIDResponse, error)

GET/v1/accounts/{account_id}

Fetch account details by ID

ParametersExpand Collapse

accountID int64

ReturnsExpand Collapse

type V1AccountGetAccountByIDResponse struct{…}

Data Account

Represents a trading account

ID int64

The unique identifier for the account

formatint64

AccountHolderEntityID int64

The account holder entity identifier

formatint64

FullName string

The full legal name of the account

OpenDate Time

The date the account was opened

formatdate

OptionsLevel int64

The options level of the account

formatint64

ShortName string

The short name of the account

Status AccountStatus

The current status of the account

One of the following:

const AccountStatusActive AccountStatus = "ACTIVE"

const AccountStatusInactive AccountStatus = "INACTIVE"

const AccountStatusClosed AccountStatus = "CLOSED"

Subtype AccountSubtype

The sub-type of account

One of the following:

const AccountSubtypeCash AccountSubtype = "CASH"

const AccountSubtypeMargin AccountSubtype = "MARGIN"

const AccountSubtypeOther AccountSubtype = "OTHER"

Type AccountType

The type of account

One of the following:

const AccountTypeCustomer AccountType = "CUSTOMER"

const AccountTypeOther AccountType = "OTHER"

CloseDate TimeOptional

The date the account was closed, if applicable

formatdate

Get Account By ID

package main

import (
  "context"
  "fmt"

  "github.com/clear-street/clear-street-go"
  "github.com/clear-street/clear-street-go/option"
)

func main() {
  client := clearstreet.NewClient(
    option.WithAPIKey("My API Key"),
  )
  response, err := client.V1.Accounts.GetAccountByID(context.TODO(), 0)
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response)
}

{
  "data": {
    "account_holder_entity_id": 987654321,
    "close_date": null,
    "full_name": "Test Trading Account",
    "id": 19816,
    "open_date": "2023-01-15",
    "short_name": "TST-ACCOUNT-01",
    "status": "ACTIVE",
    "subtype": "MARGIN",
    "type": "CUSTOMER"
  },
  "error": null,
  "metadata": {
    "request_id": "b7e2d3f4-a1b2-4c3d-8e4f-5a6b7c8d9e0f"
  }
}

{
  "data": {
    "account_holder_entity_id": 987654322,
    "close_date": "2024-08-01",
    "full_name": "Old Test Account",
    "id": 19817,
    "open_date": "2021-05-20",
    "short_name": "TST-ACCOUNT-02-CLOSED",
    "status": "CLOSED",
    "subtype": "CASH",
    "type": "CUSTOMER"
  },
  "error": null,
  "metadata": {
    "request_id": "c8f3e4a5-b2c3-5d4e-9f0a-6b7c8d9e0f1a"
  }
}

{
  "error": {
    "code": 403,
    "message": "The caller does not have permission to execute the specified operation"
  },
  "metadata": {
    "request_id": "5518f0c6-58ff-4b4a-81a5-701556d41206"
  }
}

{
  "error": {
    "code": 404,
    "message": "Some requested entity was not found"
  },
  "metadata": {
    "request_id": "67e95eb4-93b9-4010-8c9b-7ada7c2be93f"
  }
}

Returns Examples

{
  "data": {
    "account_holder_entity_id": 987654321,
    "close_date": null,
    "full_name": "Test Trading Account",
    "id": 19816,
    "open_date": "2023-01-15",
    "short_name": "TST-ACCOUNT-01",
    "status": "ACTIVE",
    "subtype": "MARGIN",
    "type": "CUSTOMER"
  },
  "error": null,
  "metadata": {
    "request_id": "b7e2d3f4-a1b2-4c3d-8e4f-5a6b7c8d9e0f"
  }
}

{
  "data": {
    "account_holder_entity_id": 987654322,
    "close_date": "2024-08-01",
    "full_name": "Old Test Account",
    "id": 19817,
    "open_date": "2021-05-20",
    "short_name": "TST-ACCOUNT-02-CLOSED",
    "status": "CLOSED",
    "subtype": "CASH",
    "type": "CUSTOMER"
  },
  "error": null,
  "metadata": {
    "request_id": "c8f3e4a5-b2c3-5d4e-9f0a-6b7c8d9e0f1a"
  }
}

{
  "error": {
    "code": 403,
    "message": "The caller does not have permission to execute the specified operation"
  },
  "metadata": {
    "request_id": "5518f0c6-58ff-4b4a-81a5-701556d41206"
  }
}

{
  "error": {
    "code": 404,
    "message": "Some requested entity was not found"
  },
  "metadata": {
    "request_id": "67e95eb4-93b9-4010-8c9b-7ada7c2be93f"
  }
}