Account

The Account endpoints provide information about your IEX Cloud account, which allow tracking of message counts, account metadata, and more.

Data weighting for all iexfinance.account endpoints is Free.

Metadata

iexfinance.account.get_metadata(**kwargs)

Metadata

Account metadata

Reference: https://iexcloud.io/docs/api/#metadata

Data Weighting: Free

Examples

from iexfinance.account import get_metadata

get_metadata()

Usage

iexfinance.account.get_usage(quota_type=None, **kwargs)

Usage

Account details, including current tier, payment status, message quote usage

Reference: https://iexcloud.io/docs/api/#usage

Data Weighting: Free

Parameters

quota_type (str, default "messages", optional) – Quotat category (messages, rules, rule-records, alerts, alert-records)

Examples

from iexfinance.account import get_usage

get_usage()

Pay as you go

iexfinance provides two methods, allow_pay_as_you_go and disallow_pay_as_you_go to toggle Pay-as-you-go for a given account.

iexfinance.account.allow_pay_as_you_go(**kwargs)

Allow Pay As You Go

Toggle ON pay-as-you-go messages

Reference: https://iexcloud.io/docs/api/#pay-as-you-go

Data Weighting: Free

iexfinance.account.disallow_pay_as_you_go(**kwargs)

Disallow Pay As You Go

Toggle OFF pay-as-you-go messages

Reference: https://iexcloud.io/docs/api/#pay-as-you-go

Data Weighting: Free

Examples

from iexfinance.account import allow_pay_as_you_go

allow_pay_as_you_go()
from iexfinance.account import disallow_pay_as_you_go

disallow_pay_as_you_go()