mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-29 13:32:08 +00:00
79046608b6
* Update generate_terminal_markdown.py * updates * update workflows * Automated Change * tests * tests * Automated Change * Update test_generate_docs.py * Automated Change * updates * Automated Change * Update gen-docs.yml * Update test.yml * Automated Change * Update test.yml * Automated Change * Update generate_sdk_markdown.py * Automated Change * test * Automated Change * testtt23 * Automated Change * Update generate_sdk_markdown.py * Automated Change * Automated Change * added empting reference folders before autogen docs * updates * Automated Change * update tests gitactions * Automated Change * up * Automated Change * Automated Change * update pytest * Automated Change * tests * Automated Change * examples update * Automated Change * Update generate_sdk_markdown.py * Automated Change * Update test.yml * Update generate_sdk_markdown.py * strip * Automated Change * Workflow : check test update * Automated Change * Automated Change * Automated Change * Update test.yml * Automated Change * Update test.yml * Automated Change * Automated Change * up * Automated Change * Update generate_sdk_markdown.py * Automated Change * update workflows * fix guides * testing * Update gh-pages.yml * Update gh-pages.yml Co-authored-by: tehcoderer <tehcoderer@users.noreply.github.com> Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com> Co-authored-by: Chavithra PARANA <chavithra@gmail.com> Co-authored-by: Chavithra <Chavithra@users.noreply.github.com> Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: jose-donato <jose-donato@users.noreply.github.com>
8.0 KiB
Vendored
8.0 KiB
Vendored
title, description
| title | description |
|---|---|
| search | OpenBB Terminal Function |
search
Show companies matching the search query
Usage
search [-q QUERY [QUERY ...]] [-c country] [-s sector] [-i industry] [-e exchange]
Parameters
| Name | Description | Default | Optional | Choices |
|---|---|---|---|---|
| query | The search term used to find company tickers | True | None | |
| country | Search by country to find stocks matching the criteria | True | afghanistan, anguilla, argentina, australia, austria, azerbaijan, bahamas, bangladesh, barbados, belgium, belize, bermuda, botswana, brazil, british_virgin_islands, cambodia, canada, cayman_islands, chile, china, colombia, costa_rica, cyprus, czech_republic, denmark, dominican_republic, egypt, estonia, falkland_islands, finland, france, french_guiana, gabon, georgia, germany, ghana, gibraltar, greece, greenland, guernsey, hong_kong, hungary, iceland, india, indonesia, ireland, isle_of_man, israel, italy, ivory_coast, japan, jersey, jordan, kazakhstan, kyrgyzstan, latvia, liechtenstein, lithuania, luxembourg, macau, macedonia, malaysia, malta, mauritius, mexico, monaco, mongolia, montenegro, morocco, mozambique, myanmar, namibia, netherlands, netherlands_antilles, new_zealand, nigeria, norway, panama, papua_new_guinea, peru, philippines, poland, portugal, qatar, reunion, romania, russia, saudi_arabia, senegal, singapore, slovakia, slovenia, south_africa, south_korea, spain, suriname, sweden, switzerland, taiwan, tanzania, thailand, turkey, ukraine, united_arab_emirates, united_kingdom, united_states, uruguay, vietnam, zambia | |
| sector | Search by sector to find stocks matching the criteria | True | , basic_materials, communication_services, conglomerates, consumer_cyclical, consumer_defensive, consumer_goods, energy, financial, financial_services, healthcare, industrial_goods, industrials, real_estate, services, technology, utilities | |
| industry | Search by industry to find stocks matching the criteria | True | , advertising_agencies, aerospace_&defense, aerospace_defense-major_diversified, aerospace_defense_products&services, agricultural_chemicals, agricultural_inputs, air_delivery&freight_services, airlines, airports&air_services, aluminum, apparel_manufacturing, apparel_retail, apparel_stores, asset_management, auto&truck_dealerships, auto_dealerships, auto_manufacturers, auto_manufacturers-major, auto_parts, banks-diversified, banks-regional, beverages-brewers, beverages-non-alcoholic, beverages-soft_drinks, beverages-wineries&distilleries, beverages-wineries&distillers, biotechnology, broadcasting, broadcasting-tv, building_materials, building_products&equipment, business_equipment, business_equipment&supplies, business_services, business_software&services, capital_markets, chemicals, chemicals-major_diversified, cigarettes, closed-end_fund-equity, coking_coal, communication_equipment, computer_based_systems, computer_hardware, confectioners, conglomerates, consulting_services, consumer_electronics, copper, credit_services, department_stores, diagnostics&_research, discount_stores, discount,variety_stores, diversified_computer_systems, diversified_electronics, diversified_investments, diversified_machinery, diversified_utilities, drug_manufacturers-general, drug_manufacturers-major, drug_manufacturers-other, drug_manufacturers-specialty&generic, drugs-generic, education&training_services, electric_utilities, electrical_equipment&parts, electronic_components, electronic_equipment, electronic_gaming&multimedia, electronics&computer_distribution, electronics_wholesale, engineering&construction, entertainment, entertainment-diversified, farm&construction_machinery, farm&heavy_construction_machinery, farm_products, financial_conglomerates, financial_data&stock_exchanges, food-major_diversified, food_distribution, food_wholesale, footwear&_accessories, furnishings,fixtures&appliances, gambling, gaming_activities, general_building_materials, general_contractors, gold, grocery_stores, health_care_plans, health_information_services, healthcare_information_services, healthcare_plans, heavy_construction, home_furnishings&fixtures, home_improvement_retail, hospitals, household&personal_products, independent_oil&gas, industrial_distribution, industrial_equipment_wholesale, industrial_metals&minerals, information_technology_services, infrastructure_operations, insurance-diversified, insurance-life, insurance-property&casualty, insurance-reinsurance, insurance-specialty, insurance_brokers, integrated_freight&logistics, internet_content&information, internet_information_providers, internet_retail, internet_service_providers, internet_software&services, investment_brokerage-national, jewelry_stores, leisure, life_insurance, lodging, long_distance_carriers, lumber&_wood_production, lumber,wood_production, luxury_goods, machine_tools&accessories, major_airlines, major_integrated_oil&gas, marine_shipping, marketing_services, medical_appliances&equipment, medical_care_facilities, medical_devices, medical_distribution, medical_instruments&supplies, medical_laboratories&research, metal_fabrication, money_center_banks, mortgage_finance, mortgage_investment, multimedia&graphics_software, networking&communication_devices, nonmetallic_mineral_mining, oil&gas_drilling, oil&gas_drilling&exploration, oil&gas_e&p, oil&gas_equipment&services, oil&gas_integrated, oil&gas_midstream, oil&gas_pipelines, oil&gas_refining&marketing, other_industrial_metals&mining, other_precious_metals&mining, packaged_foods, packaging&containers, paper&paper_products, personal_products, personal_services, pharmaceutical_retailers, pollution&treatment_controls, printed_circuit_boards, processed&packaged_goods, property&casualty_insurance, property_management, publishing, publishing-newspapers, reit-diversified, reit-healthcare_facilities, reit-hotel&motel, reit-industrial, reit-mortgage, reit-office, reit-residential, reit-retail, reit-specialty, railroads, real_estate-development, real_estate-_diversified, real_estate_development, real_estate_services, recreational_goods,other, recreational_vehicles, regional-mid-atlantic_banks, rental&leasing_services, research_services, residential_construction, resorts&casinos, restaurants, rubber&plastics, scientific&technical_instruments, security&protection_services, security_software&services, semiconductor-broad_line, semiconductor_equipment&_materials, semiconductor-memory_chips, semiconductors, shell_companies, shipping, silver, software-application, software-_infrastructure, solar, specialized_health_services, specialty_business_services, specialty_chemicals, specialty_industrial_machinery, specialty_retail, specialty_retail,other, staffing&employment_services, staffing&outsourcing_services, steel, steel&iron, technical&system_software, telecom_services, textile-apparel_clothing, textile-apparel_footwear&_accessories, textile_industrial, textile_manufacturing, thermal_coal, tobacco, tobacco_products,other, tools&accessories, travel_services, trucking, trucks&other_vehicles, uranium, utilities-diversified, utilities-independent_power_producers, utilities-regulated_electric, utilities-regulated_gas, utilities-regulated_water, utilities-_renewable, waste_management, water_utilities, wireless_communications | |
| exchange_country | Search by a specific exchange country to find stocks matching the criteria | True | united_states, argentina, austria, australia, belgium, brazil, canada, chile, china, czech_republic, denmark, egypt, estonia, europe, finland, france, germany, greece, hong_kong, hungary, iceland, india, indonesia, ireland, israel, italy, japan, latvia, lithuania, malaysia, mexico, netherlands, new_zealand, norway, portugal, qatar, russia, singapore, south_africa, south_korea, spain, saudi_arabia, sweden, switzerland, taiwan, thailand, turkey, united_kingdom, venezuela |