Enums¶

TaxIdType¶

enum alpaca.broker.enums.TaxIdType(value)¶

The various country specific tax identification numbers

see https://alpaca.markets/docs/broker/api-references/accounts/accounts/#tax-id-type

Member Type:: str

Valid values are as follows:

USA_SSN = <TaxIdType.USA_SSN: 'USA_SSN'>¶

USA_ITIN = <TaxIdType.USA_ITIN: 'USA_ITIN'>¶

ARG_AR_CUIT = <TaxIdType.ARG_AR_CUIT: 'ARG_AR_CUIT'>¶

AUS_TFN = <TaxIdType.AUS_TFN: 'AUS_TFN'>¶

AUS_ABN = <TaxIdType.AUS_ABN: 'AUS_ABN'>¶

BOL_NIT = <TaxIdType.BOL_NIT: 'BOL_NIT'>¶

BRA_CPF = <TaxIdType.BRA_CPF: 'BRA_CPF'>¶

CHL_RUT = <TaxIdType.CHL_RUT: 'CHL_RUT'>¶

COL_NIT = <TaxIdType.COL_NIT: 'COL_NIT'>¶

CRI_NITE = <TaxIdType.CRI_NITE: 'CRI_NITE'>¶

DEU_TAX_ID = <TaxIdType.DEU_TAX_ID: 'DEU_TAX_ID'>¶

DOM_RNC = <TaxIdType.DOM_RNC: 'DOM_RNC'>¶

ECU_RUC = <TaxIdType.ECU_RUC: 'ECU_RUC'>¶

FRA_SPI = <TaxIdType.FRA_SPI: 'FRA_SPI'>¶

GBR_UTR = <TaxIdType.GBR_UTR: 'GBR_UTR'>¶

GBR_NINO = <TaxIdType.GBR_NINO: 'GBR_NINO'>¶

GTM_NIT = <TaxIdType.GTM_NIT: 'GTM_NIT'>¶

HND_RTN = <TaxIdType.HND_RTN: 'HND_RTN'>¶

HUN_TIN = <TaxIdType.HUN_TIN: 'HUN_TIN'>¶

IDN_KTP = <TaxIdType.IDN_KTP: 'IDN_KTP'>¶

IND_PAN = <TaxIdType.IND_PAN: 'IND_PAN'>¶

ISR_TAX_ID = <TaxIdType.ISR_TAX_ID: 'ISR_TAX_ID'>¶

ITA_TAX_ID = <TaxIdType.ITA_TAX_ID: 'ITA_TAX_ID'>¶

JPN_TAX_ID = <TaxIdType.JPN_TAX_ID: 'JPN_TAX_ID'>¶

MEX_RFC = <TaxIdType.MEX_RFC: 'MEX_RFC'>¶

NIC_RUC = <TaxIdType.NIC_RUC: 'NIC_RUC'>¶

NLD_TIN = <TaxIdType.NLD_TIN: 'NLD_TIN'>¶

PAN_RUC = <TaxIdType.PAN_RUC: 'PAN_RUC'>¶

PER_RUC = <TaxIdType.PER_RUC: 'PER_RUC'>¶

PRY_RUC = <TaxIdType.PRY_RUC: 'PRY_RUC'>¶

SGP_NRIC = <TaxIdType.SGP_NRIC: 'SGP_NRIC'>¶

SGP_FIN = <TaxIdType.SGP_FIN: 'SGP_FIN'>¶

SGP_ASGD = <TaxIdType.SGP_ASGD: 'SGP_ASGD'>¶

SGP_ITR = <TaxIdType.SGP_ITR: 'SGP_ITR'>¶

SLV_NIT = <TaxIdType.SLV_NIT: 'SLV_NIT'>¶

SWE_TAX_ID = <TaxIdType.SWE_TAX_ID: 'SWE_TAX_ID'>¶

URY_RUT = <TaxIdType.URY_RUT: 'URY_RUT'>¶

VEN_RIF = <TaxIdType.VEN_RIF: 'VEN_RIF'>¶

NATIONAL_ID = <TaxIdType.NATIONAL_ID: 'NATIONAL_ID'>¶

PASSPORT = <TaxIdType.PASSPORT: 'PASSPORT'>¶

PERMANENT_RESIDENT = <TaxIdType.PERMANENT_RESIDENT: 'PERMANENT_RESIDENT'>¶

DRIVER_LICENSE = <TaxIdType.DRIVER_LICENSE: 'DRIVER_LICENSE'>¶

OTHER_GOV_ID = <TaxIdType.OTHER_GOV_ID: 'OTHER_GOV_ID'>¶

NOT_SPECIFIED = <TaxIdType.NOT_SPECIFIED: 'NOT_SPECIFIED'>¶

VisaType¶

enum alpaca.broker.enums.VisaType(value)¶

In addition to the following USA visa categories, we accept any sub visas of the list below. Sub visas must be passed in according to their parent category. Note that United States green card holders are considered permanent residents and should not pass in a visa type.

Please feel free to reach out to Alpaca if you need other tax ID types.

see https://alpaca.markets/docs/broker/api-references/accounts/accounts/#visa-type

Member Type:: str

Valid values are as follows:

B1 = <VisaType.B1: 'B1'>¶

B2 = <VisaType.B2: 'B2'>¶

DACA = <VisaType.DACA: 'DACA'>¶

E1 = <VisaType.E1: 'E1'>¶

E2 = <VisaType.E2: 'E2'>¶

E3 = <VisaType.E3: 'E3'>¶

F1 = <VisaType.F1: 'F1'>¶

G4 = <VisaType.G4: 'G4'>¶

H1B = <VisaType.H1B: 'H1B'>¶

J1 = <VisaType.J1: 'J1'>¶

L1 = <VisaType.L1: 'L1'>¶

Other = <VisaType.Other: 'OTHER'>¶

O1 = <VisaType.O1: 'O1'>¶

TN1 = <VisaType.TN1: 'TN1'>¶

FundingSource¶

enum alpaca.broker.enums.FundingSource(value)¶

Various sources of funding for brokerage accounts.

see https://alpaca.markets/docs/broker/api-references/accounts/accounts/#funding-source

Member Type:: str

Valid values are as follows:

EMPLOYMENT_INCOME = <FundingSource.EMPLOYMENT_INCOME: 'employment_income'>¶

INVESTMENTS = <FundingSource.INVESTMENTS: 'investments'>¶

INHERITANCE = <FundingSource.INHERITANCE: 'inheritance'>¶

BUSINESS_INCOME = <FundingSource.BUSINESS_INCOME: 'business_income'>¶

SAVINGS = <FundingSource.SAVINGS: 'savings'>¶

FAMILY = <FundingSource.FAMILY: 'family'>¶

EmploymentStatus¶

enum alpaca.broker.enums.EmploymentStatus(value)¶

The possible employment statuses of the user

see https://alpaca.markets/docs/broker/api-references/accounts/accounts/#employment-status

Member Type:: str

Valid values are as follows:

UNEMPLOYED = <EmploymentStatus.UNEMPLOYED: 'UNEMPLOYED'>¶

EMPLOYED = <EmploymentStatus.EMPLOYED: 'EMPLOYED'>¶

STUDENT = <EmploymentStatus.STUDENT: 'STUDENT'>¶

RETIRED = <EmploymentStatus.RETIRED: 'RETIRED'>¶

AgreementType¶

enum alpaca.broker.enums.AgreementType(value)¶

The types of agreements that are to be signed by the user

see https://docs.alpaca.markets/reference/createaccount

MARGIN, ACCOUNT, CUSTOMER, CRYPTO, and OPTIONS are deprecated and will be removed in the next release. Use MARGIN_AGREEMENT, ACCOUNT_AGREEMENT, CUSTOMER_AGREEMENT, CRYPTO_AGREEMENT, and OPTIONS_AGREEMENT. The wire values are unchanged.

CUSTODIAL_CUSTOMER is deprecated and will be removed in the next release. It is no longer a valid agreement type.

Member Type:: str

Valid values are as follows:

MARGIN_AGREEMENT = <AgreementType.MARGIN_AGREEMENT: 'margin_agreement'>¶

ACCOUNT_AGREEMENT = <AgreementType.ACCOUNT_AGREEMENT: 'account_agreement'>¶

CUSTOMER_AGREEMENT = <AgreementType.CUSTOMER_AGREEMENT: 'customer_agreement'>¶

CRYPTO_AGREEMENT = <AgreementType.CRYPTO_AGREEMENT: 'crypto_agreement'>¶

OPTIONS_AGREEMENT = <AgreementType.OPTIONS_AGREEMENT: 'options_agreement'>¶

CUSTODIAL_CUSTOMER = <AgreementType.CUSTODIAL_CUSTOMER: 'custodial_customer_agreement'>¶

DocumentType¶

enum alpaca.broker.enums.DocumentType(value)¶

Represents the kind of document data you’re uploading

please see https://alpaca.markets/docs/broker/api-references/accounts/accounts/#document-type and https://alpaca.markets/docs/api-references/broker-api/documents/#enumuploaddocumenttype for more info

Member Type:: str

Valid values are as follows:

IDENTITY_VERIFICATION = <DocumentType.IDENTITY_VERIFICATION: 'identity_verification'>¶

ADDRESS_VERIFICATION = <DocumentType.ADDRESS_VERIFICATION: 'address_verification'>¶

DATE_OF_BIRTH_VERIFICATION = <DocumentType.DATE_OF_BIRTH_VERIFICATION: 'date_of_birth_verification'>¶

TAX_ID_VERIFICATION = <DocumentType.TAX_ID_VERIFICATION: 'tax_id_verification'>¶

ACCOUNT_APPROVAL_LETTER = <DocumentType.ACCOUNT_APPROVAL_LETTER: 'account_approval_letter'>¶

LIMITED_TRADING_AUTHORIZATION = <DocumentType.LIMITED_TRADING_AUTHORIZATION: 'limited_trading_authorization'>¶

W8BEN = <DocumentType.W8BEN: 'w8ben'>¶

SOCIAL_SECURITY_NUMBER_VERIFICATION = <DocumentType.SOCIAL_SECURITY_NUMBER_VERIFICATION: 'social_security_number_verification'>¶

NULL = <DocumentType.NULL: ''>¶

CIP_RESULT = <DocumentType.CIP_RESULT: 'cip_result'>¶

OTHER = <DocumentType.OTHER: 'other'>¶

AccountEntities¶

enum alpaca.broker.enums.AccountEntities(value)¶

An enum representing the different fields to query for when listing accounts.

ie: asking for CONTACT and IDENTITY will have the api fill those fields when returning the list of Accounts however other fields on the account will be nulled out where possible.

Member Type:: str

Valid values are as follows:

CONTACT = <AccountEntities.CONTACT: 'contact'>¶

IDENTITY = <AccountEntities.IDENTITY: 'identity'>¶

DISCLOSURES = <AccountEntities.DISCLOSURES: 'disclosures'>¶

AGREEMENTS = <AccountEntities.AGREEMENTS: 'agreements'>¶

DOCUMENTS = <AccountEntities.DOCUMENTS: 'documents'>¶

TRUSTED_CONTACT = <AccountEntities.TRUSTED_CONTACT: 'trusted_contact'>¶

USER_CONFIGURATIONS = <AccountEntities.USER_CONFIGURATIONS: 'trading_configurations'>¶

ClearingBroker¶

enum alpaca.broker.enums.ClearingBroker(value)¶

An enum for representing what Clearing broker an Account is assigned to

Member Type:: str

Valid values are as follows:

Apex = <ClearingBroker.Apex: 'APEX'>¶

ETC = <ClearingBroker.ETC: 'ETC'>¶

IC = <ClearingBroker.IC: 'IC'>¶

Velox = <ClearingBroker.Velox: 'VELOX'>¶

Vision = <ClearingBroker.Vision: 'VISION'>¶

Self = <ClearingBroker.Self: 'SELF'>¶

Alpaca_APCA = <ClearingBroker.Alpaca_APCA: 'ALPACA_APCA'>¶

CIPProvider¶

enum alpaca.broker.enums.CIPProvider(value)¶

Enum representing what CIP provider was used.

see https://alpaca.markets/docs/api-references/broker-api/accounts/accounts/#cip-provider for more info

Member Type:: str

Valid values are as follows:

ALLOY = <CIPProvider.ALLOY: 'alloy'>¶

TRULIOO = <CIPProvider.TRULIOO: 'trulioo'>¶

ONFIDO = <CIPProvider.ONFIDO: 'onfido'>¶

VERIFF = <CIPProvider.VERIFF: 'veriff'>¶

JUMIO = <CIPProvider.JUMIO: 'jumio'>¶

GETMATI = <CIPProvider.GETMATI: 'getmati'>¶

CIPStatus¶

enum alpaca.broker.enums.CIPStatus(value)¶

An enum representing the status of the CIPInfo

see https://alpaca.markets/docs/api-references/broker-api/accounts/accounts/#cip-status for more info

Member Type:: str

Valid values are as follows:

COMPLETE = <CIPStatus.COMPLETE: 'complete'>¶

WITHDRAWN = <CIPStatus.WITHDRAWN: 'withdrawn'>¶

CIPResult¶

enum alpaca.broker.enums.CIPResult(value)¶

see https://alpaca.markets/docs/api-references/broker-api/accounts/accounts/#cip-result for more info

Member Type:: str

Valid values are as follows:

CLEAR = <CIPResult.CLEAR: 'clear'>¶

CONSIDER = <CIPResult.CONSIDER: 'consider'>¶

CIPApprovalStatus¶

enum alpaca.broker.enums.CIPApprovalStatus(value)¶

Either approved or rejected

Member Type:: str

Valid values are as follows:

APPROVED = <CIPApprovalStatus.APPROVED: 'approved'>¶

REJECTED = <CIPApprovalStatus.REJECTED: 'rejected'>¶

TradeDocumentType¶

enum alpaca.broker.enums.TradeDocumentType(value)¶

Represents what kind information is inside a TradeDocument

Most likely will be either of these 3:

ACCOUNT_STATEMENT
TRADE_CONFIRMATION
TAX_STATEMENT

However, for older accounts with legacy documents the other legacy values might show up.

please see https://alpaca.markets/docs/api-references/broker-api/documents/#enumdocumenttype for more info

Member Type:: str

Valid values are as follows:

ACCOUNT_STATEMENT = <TradeDocumentType.ACCOUNT_STATEMENT: 'account_statement'>¶

TRADE_CONFIRMATION = <TradeDocumentType.TRADE_CONFIRMATION: 'trade_confirmation'>¶

TRADE_CONFIRMATION_JSON = <TradeDocumentType.TRADE_CONFIRMATION_JSON: 'trade_confirmation_json'>¶

TAX_STATEMENT = <TradeDocumentType.TAX_STATEMENT: 'tax_statement'>¶

ACCOUNT_APPLICATION = <TradeDocumentType.ACCOUNT_APPLICATION: 'account_application'>¶

TAX_1099_B_DETAILS = <TradeDocumentType.TAX_1099_B_DETAILS: 'tax_1099_b_details'>¶

TAX_1099_B_FORM = <TradeDocumentType.TAX_1099_B_FORM: 'tax_1099_b_form'>¶

TAX_1099_DIV_DETAILS = <TradeDocumentType.TAX_1099_DIV_DETAILS: 'tax_1099_div_details'>¶

TAX_1099_DIV_FORM = <TradeDocumentType.TAX_1099_DIV_FORM: 'tax_1099_div_form'>¶

TAX_1099_INT_DETAILS = <TradeDocumentType.TAX_1099_INT_DETAILS: 'tax_1099_int_details'>¶

TAX_1099_INT_FORM = <TradeDocumentType.TAX_1099_INT_FORM: 'tax_1099_int_form'>¶

TAX_W8 = <TradeDocumentType.TAX_W8: 'tax_w8'>¶

TradeDocumentSubType¶

enum alpaca.broker.enums.TradeDocumentSubType(value)¶

Represents additional information for whats inside a TradeDocument in combination with a TradeDocumentType

please see https://alpaca.markets/docs/api-references/broker-api/documents/#the-document-object for more info

Member Type:: str

Valid values are as follows:

TYPE_1099_COMP = <TradeDocumentSubType.TYPE_1099_COMP: '1099-Comp'>¶

TYPE_1042_S = <TradeDocumentSubType.TYPE_1042_S: '1042-S'>¶

TYPE_480_6 = <TradeDocumentSubType.TYPE_480_6: '480.6'>¶

COURTESY_STATEMENT = <TradeDocumentSubType.COURTESY_STATEMENT: 'courtesy_statement'>¶

UploadDocumentSubType¶

enum alpaca.broker.enums.UploadDocumentSubType(value)¶

Represents a sub type for an UploadDocumentRequest

please see: https://alpaca.markets/docs/api-references/broker-api/documents/#enumuploaddocumentsubtype for more info

Member Type:: str

Valid values are as follows:

ACCOUNT_APPLICATION = <UploadDocumentSubType.ACCOUNT_APPLICATION: 'Account Application'>¶

FORM_W8_BEN = <UploadDocumentSubType.FORM_W8_BEN: 'Form W-8BEN'>¶

PASSPORT = <UploadDocumentSubType.PASSPORT: 'passport'>¶

UploadDocumentMimeType¶

enum alpaca.broker.enums.UploadDocumentMimeType(value)¶

specifies the mime type of the base64 data you’re uploading as part of a UploadDocumentRequest

please see https://alpaca.markets/docs/api-references/broker-api/documents/#parameters for more info

Member Type:: str

Valid values are as follows:

PDF = <UploadDocumentMimeType.PDF: 'application/pdf'>¶

PNG = <UploadDocumentMimeType.PNG: 'image/png'>¶

JPEG = <UploadDocumentMimeType.JPEG: 'image/jpeg'>¶

JSON = <UploadDocumentMimeType.JSON: 'application/json'>¶

ACHRelationshipStatus¶

enum alpaca.broker.enums.ACHRelationshipStatus(value)¶

Represents the state that an ACHRelationship is in.

Please see https://alpaca.markets/docs/api-references/broker-api/funding/ach/#attributes for more details

Member Type:: str

Valid values are as follows:

QUEUED = <ACHRelationshipStatus.QUEUED: 'QUEUED'>¶

APPROVED = <ACHRelationshipStatus.APPROVED: 'APPROVED'>¶

PENDING = <ACHRelationshipStatus.PENDING: 'PENDING'>¶

REJECTED = <ACHRelationshipStatus.REJECTED: 'REJECTED'>¶

CANCEL_REQUESTED = <ACHRelationshipStatus.CANCEL_REQUESTED: 'CANCEL_REQUESTED'>¶

BankAccountType¶

enum alpaca.broker.enums.BankAccountType(value)¶

Represents a kind of bank account.

Please see https://alpaca.markets/docs/api-references/broker-api/funding/ach/#attributes

NONE is deprecated and will be removed in the next release. It is no longer a valid bank account type.

Member Type:: str

Valid values are as follows:

CHECKING = <BankAccountType.CHECKING: 'CHECKING'>¶

SAVINGS = <BankAccountType.SAVINGS: 'SAVINGS'>¶

NONE = <BankAccountType.NONE: ''>¶

IdentifierType¶

enum alpaca.broker.enums.IdentifierType(value)¶

Represents a type of bank account.

Please see https://alpaca.markets/docs/api-references/broker-api/funding/bank/#creating-a-new-bank-relationship for more details.

Member Type:: str

Valid values are as follows:

ABA = <IdentifierType.ABA: 'ABA'>¶

BIC = <IdentifierType.BIC: 'BIC'>¶

BankStatus¶

enum alpaca.broker.enums.BankStatus(value)¶

Represents the states a Bank instance can be in.

Please see https://alpaca.markets/docs/api-references/broker-api/funding/bank/#enumbankstatus for more details.

Member Type:: str

Valid values are as follows:

QUEUED = <BankStatus.QUEUED: 'QUEUED'>¶

SENT_TO_CLEARING = <BankStatus.SENT_TO_CLEARING: 'SENT_TO_CLEARING'>¶

APPROVED = <BankStatus.APPROVED: 'APPROVED'>¶

REJECTED = <BankStatus.REJECTED: 'REJECTED'>¶

CANCELED = <BankStatus.CANCELED: 'CANCELED'>¶

RecipientBankStatus¶

enum alpaca.broker.enums.RecipientBankStatus(value)¶

Filter for listing recipient banks.

This is the status query on GET /v1/accounts/{account_id}/recipient_banks. It is separate from BankStatus, which is the lifecycle state returned on a bank.

Member Type:: str

Valid values are as follows:

ACTIVE = <RecipientBankStatus.ACTIVE: 'ACTIVE'>¶

INACTIVE = <RecipientBankStatus.INACTIVE: 'INACTIVE'>¶

TransferType¶

enum alpaca.broker.enums.TransferType(value)¶

Represents the types of transfers that can be made.

Please see https://alpaca.markets/docs/api-references/broker-api/funding/transfers/#enumtransfertype for more details.

Member Type:: str

Valid values are as follows:

ACH = <TransferType.ACH: 'ach'>¶

WIRE = <TransferType.WIRE: 'wire'>¶

TransferStatus¶

enum alpaca.broker.enums.TransferStatus(value)¶

Represents the states a Transfer instance can be in.

Please see https://alpaca.markets/docs/api-references/broker-api/funding/transfers/#enumtransferstatus for more details.

SETTLED is deprecated and will be removed in the next release. It is no longer a valid transfer status.

Member Type:: str

Valid values are as follows:

QUEUED = <TransferStatus.QUEUED: 'QUEUED'>¶

APPROVAL_PENDING = <TransferStatus.APPROVAL_PENDING: 'APPROVAL_PENDING'>¶

PENDING = <TransferStatus.PENDING: 'PENDING'>¶

SENT_TO_CLEARING = <TransferStatus.SENT_TO_CLEARING: 'SENT_TO_CLEARING'>¶

REJECTED = <TransferStatus.REJECTED: 'REJECTED'>¶

CANCELED = <TransferStatus.CANCELED: 'CANCELED'>¶

APPROVED = <TransferStatus.APPROVED: 'APPROVED'>¶

SETTLED = <TransferStatus.SETTLED: 'SETTLED'>¶

COMPLETE = <TransferStatus.COMPLETE: 'COMPLETE'>¶

RETURNED = <TransferStatus.RETURNED: 'RETURNED'>¶

TransferDirection¶

enum alpaca.broker.enums.TransferDirection(value)¶

Represents the direction of the transfer.

Please see https://alpaca.markets/docs/api-references/broker-api/funding/transfers/#enumtransferdirection for more details.

Member Type:: str

Valid values are as follows:

INCOMING = <TransferDirection.INCOMING: 'INCOMING'>¶

OUTGOING = <TransferDirection.OUTGOING: 'OUTGOING'>¶

FeePaymentMethod¶

enum alpaca.broker.enums.FeePaymentMethod(value)¶

Represents who is responsible for paying fees associated with the transfer.

Please see https://alpaca.markets/docs/api-references/broker-api/funding/transfers/#enumfeepaymentmethod for more details.

Member Type:: str

Valid values are as follows:

USER = <FeePaymentMethod.USER: 'user'>¶

INVOICE = <FeePaymentMethod.INVOICE: 'invoice'>¶

JournalEntryType¶

enum alpaca.broker.enums.JournalEntryType(value)¶

Represents the types of journals. Cash journals are transfers of cash. Security journals are transfers of securities like stocks.

Please see https://alpaca.markets/docs/api-references/broker-api/journals/ for more details.

Member Type:: str

Valid values are as follows:

CASH = <JournalEntryType.CASH: 'JNLC'>¶

SECURITY = <JournalEntryType.SECURITY: 'JNLS'>¶

JournalStatus¶

enum alpaca.broker.enums.JournalStatus(value)¶

The various states a journal can be in during its lifecycle.

Please see https://alpaca.markets/docs/api-references/broker-api/journals/#enumjournalstatus for more details.

Member Type:: str

Valid values are as follows:

QUEUED = <JournalStatus.QUEUED: 'queued'>¶

SENT_TO_CLEARING = <JournalStatus.SENT_TO_CLEARING: 'sent_to_clearing'>¶

PENDING = <JournalStatus.PENDING: 'pending'>¶

EXECUTED = <JournalStatus.EXECUTED: 'executed'>¶

REJECTED = <JournalStatus.REJECTED: 'rejected'>¶

CANCELED = <JournalStatus.CANCELED: 'canceled'>¶

REFUSED = <JournalStatus.REFUSED: 'refused'>¶

CORRECT = <JournalStatus.CORRECT: 'correct'>¶

DELETED = <JournalStatus.DELETED: 'deleted'>¶

ACTIVITY_CREATED = <JournalStatus.ACTIVITY_CREATED: 'activity_created'>¶