Create Symbol

Creates a new Symbol for the authenticated user. Request body must be submitted as multipart/form-data. Many fields are conditional and only relevant depending on the values of other fields (see individual field descriptions).

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

reason_for_entry*string

Reason for creating the symbol entry. See Field Reference for allowed values.

symbol*string

Ticker symbol (e.g. HOODX). Min 2, max 12 characters.

symbol_id?|

Required when reason_for_entry is 'Link Symbol to Underlying Symbol'. ID of the master symbol to link to.

is_instrument_platform?boolean

Whether the instrument is a platform token

instrument_class*string

Asset instrument class. See Field Reference for allowed values.

equity_type?string

Required when instrument_class is 'Equity'. See Field Reference for allowed values.

alternative_asset_category?string

Shown when equity_type is 'Private'. See Field Reference for allowed values.

alternative_asset_subcategory?string

Shown when alternative_asset_category has subcategories. Values depend on alternative_asset_category: Private Funds → Traditional 3(c)(1) Fund / 3(c)(7) Fund / 3(c)(1) Qualifying Venture Capital Fund; Real Estate → Commercial / Residential; Collectibles → Books / Cars / Comics / One-of-a-kind collectibles / Sports cards and memorabilia / Trading cards. See Field Reference for allowed values.

exempted_offerings?string

Shown when equity_type is 'Private' or instrument_class is 'Debt'. See Field Reference for allowed values.

debt_instrument?string

Shown when instrument_class is 'Debt'. See Field Reference for allowed values.

face_value_par_value?number

Shown when debt_instrument is selected. Face value / par value of the debt instrument.

coupon_interest_rate?number

Shown when debt_instrument is selected. Coupon / interest rate.

maturity_date?string

Shown when debt_instrument is selected. Format: YYYY-MM-DD

payment_frequency?string

Shown when debt_instrument is selected. See Field Reference for allowed values.

stablecoin_type?string

Required when instrument_class is 'Stablecoin'. See Field Reference for allowed values.

commodity_type?string

Required when instrument_class is 'Commodity'. See Field Reference for allowed values.

commodity_subcategory?string

Shown when commodity_type has subcategories. Values depend on commodity_type: Precious Metals → Gold / Silver / Platinum / Palladium / Basket Multiple; Agriculture → Corn / Soybeans / Soybean Oil / Cotton / Wheat / Basket Multiple; Energy → Oil / Natural Gas / Basket Multiple; Industrial Metals → Copper / Aluminum / Nickel / Basket Multiple; Environmental / Green → Green Financing / Carbon Credits / Renewable Energy Certificates / Basket Multiple; Mixed Commodities → Multi-Commodity Basket. See Field Reference for allowed values.

fifth_character_identifier?string

Fifth character identifier appended to the ticker symbol. See Field Reference for allowed values.

security_name*string

Full name of the security. The ticker symbol is auto-generated from this value.

asset_status*string

Current status of the asset. See Field Reference for allowed values.

cusip?string

CUSIP number (9 characters)

isin?string

ISIN number (12 characters)

is_link_to_coingecko?boolean

Whether to link this symbol to a matching CoinGecko asset (only applicable when the symbol matches a known CoinGecko asset)

market_sector*string

Market sector of the asset. See Field Reference for allowed values.

market_sector_category?string

Shown when the selected market_sector has subcategories. Values depend on market_sector: Consumer Discretionary → Automobiles & Components / Content / Gaming; Education → Online Learning Platforms / Professional Education / Student & Classroom Services; Energy → Batteries & Charging; Enterprise → AI/ML / Autonomous Driving Systems / Cloud & Infrastructure / Cybersecurity / Developer Tools / Engineering & Architecture / Marketing / Other Software & Services / Productivity & Collaboration / Sales & Support / Security & Defense / Talent & HR / Video & Communication; Financials → Capital Markets / Cards & Banking (B2C) / Financial Infrastructure / Financial Insights & Analytics / Insurance Services / Integrated Payment Systems / Life & Health Insurance / Merchant Services / Multi-Line & Other Insurance; Financial Asset (Crypto) → Crypto Gaming & NFTs / Crypto Infrastructure / Crypto / Blockchain; Hardware → Medical Equipment & Devices / Rockets & Spacecraft / Satellites & LEO / Semiconductors; Healthcare → Biotech Tools & Platforms / Drug Discovery & Development / Healthcare Systems / Telehealth / Telemed; Materials → Specialty Materials & Textiles. See Field Reference for allowed values.

lot_size*integer

Lot size for the symbol (integer value)

fractional_lot_size?number

Fractional lot size (up to 6 decimal places)

mvp?number

Minimum Price Variation (MPV). Typical values: 0.01, 0.05, 0.10

country?string

Country code (ISO 3166-1 alpha-2, e.g. US, GB, DE)

primary_ats*string

Primary data source / ATS name. Pass an existing ATS name or a new name. Use 'None' for no ATS.

new_primary_ats?string

Required when primary_ats is 'Add New'. The name of the new ATS to register.

primary_market?string

Primary market for the symbol

transfer_agent?string

Transfer agent name

custodian?string

Custodian name

edgar_cik?string

SEC EDGAR CIK number (see https://www.sec.gov/edgar/searchedgar/companysearch)

issue_date?string

Date of issue / creation. Format: YYYY-MM-DD

governance_notes?string

Issuance / governance notes (e.g. DAO, corporate board, free-form text)

digital_asset_category?string

Digital asset category classification. See Field Reference for allowed values.

instrument_type?string

Shown when the selected digital_asset_category has instrument types. Values depend on digital_asset_category: Money or Money-Like → Central Bank Digital Currency / Bank Deposit / Reserved Bank Digital Currencies / Stablecoins; Financial → Tokenized Security (Twin) / Security Token (Native) / Tokenized Derivative (Twin) / Derivative Token (Native); Alternative → Tokenized Alternative Asset (Twin); Cryptoassets → Platform Cryptoasset (e.g. Bitcoin, Ether) / Other Cryptoassets (Meme Coins); Functional → Utility Token; Settlement Controllable → Transfer of Ownership. See Field Reference for allowed values.

sec_token_classification?string

SEC token classification. See Field Reference for allowed values.

issuer_name?string

Asset issuer name

issuer_type?string

Asset issuer type. See Field Reference for allowed values.

tokenization_platform?string

Tokenization platform name

underpinning_asset_value?string

Underpinning asset value type. See Field Reference for allowed values.

reference_asset?string

Shown when underpinning_asset_value is 'Pegged'. The reference asset for the peg.

backing_collateral_details?string

Backing / collateral details type. See Field Reference for allowed values.

backing_collateral_details_text?string

Shown when backing_collateral_details is 'Enter Text'. Free-form text description of collateral.

rights_type?string

Rights type associated with the asset. See Field Reference for allowed values.

enforceability_type?string

Legal enforceability type. See Field Reference for allowed values.

fungibility_type?string

Fungibility type. See Field Reference for allowed values.

redeemability_type?string

Redeemability type. See Field Reference for allowed values.

redemption_asset_type?string

Shown when redeemability_type is 'Redeemable'. Type of asset used for redemption.

nature_of_record?string

Nature of record. See Field Reference for allowed values.

settlement_method?string

Settlement method. See Field Reference for allowed values.

custody_arrangement?string

Custody arrangement. See Field Reference for allowed values.

associated_network?array<>

Associated blockchain networks / ledgers (multi-select). See Field Reference for allowed values.

notes?string

Free-form notes / comments

spv_name?string

SPV (Special Purpose Vehicle) name.

market_dynamics_description?string

Market dynamics description.

Response Body

`application/json`

curl -X POST "https://example.com/backend/api/v1/asset/user_assets/" \  -F reason_for_entry="New Ticker Symbol" \  -F symbol="TEST1" \  -F instrument_class="Equity" \  -F equity_type="Listed" \  -F security_name="Test Security" \  -F asset_status="Active" \  -F cusip="925524BF6" \  -F isin="US9255247080" \  -F market_sector="Information Technology" \  -F lot_size="1" \  -F fractional_lot_size="0.000001" \  -F mvp="0.01" \  -F country="US" \  -F primary_ats="ATS-1" \  -F transfer_agent="Agent Name" \  -F custodian="Custodian Name" \  -F edgar_cik="0001234567" \  -F issue_date="2024-01-15" \  -F digital_asset_category="Financial Digital Assets" \  -F instrument_type="Security Token (Native)" \  -F sec_token_classification="Tokenized Security" \  -F issuer_name="Example Corp" \  -F issuer_type="Corporation" \  -F tokenization_platform="Example Platform" \  -F underpinning_asset_value="None" \  -F backing_collateral_details="Cash" \  -F rights_type="Monetary Claim" \  -F enforceability_type="Legally Enforceable" \  -F fungibility_type="Fungible" \  -F redeemability_type="Non-Redeemable" \  -F nature_of_record="Digital Native" \  -F settlement_method="On-Chain" \  -F custody_arrangement="Third-Party" \  -F associated_network="[    \"Ethereum\"  ]" \  -F notes="Example symbol created via API"

{  "message": "success",  "code": 200}

Create Symbol

Authorization

Request Body

Response Body

200application/json

`application/json`