mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-05 00:42:19 +00:00
4ad995fdd0
* add first iteration of content for Terminal Pro * Update index.md * Update dashboards.md * Update folders.md * Update grouping.md * Update report.md * Update templates.md * Update quick-start.md * Update index.md * Update index.md * Update home.md * Update news.md * Update index.md * Update index.md * Update index.md * Update data-provider.md * Update chat-with-widget.md * Update data-manipulation.md * Update forecasting.md * fix: images self closing tags * fix: only pro visitors can see pro * inter font * improve SEO content and restructuring * add new package for toggle on tutorials * move folder around * improve main page of each prod * small updates and improvements * fix logo above * small improvement in headtitle for portfolio funcs * fix typos from OpenAI's GPT-4 * fix _category_ json * remove generic SEO words * add script that generates SEO for documentation * add missing file * remove sdk warning message * fix links for andrew --------- Co-authored-by: jose-donato <zmcdonato@gmail.com> Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
42 lines
8.5 KiB
Markdown
Vendored
42 lines
8.5 KiB
Markdown
Vendored
---
|
|
title: search
|
|
description: The 'search' documentation provides a detailed guide to using various
|
|
search commands on our platform. This includes usage, parameters, and term definitions
|
|
for finding company tickers, filtering stocks based on country, sector, industry
|
|
or specific exchange country.
|
|
keywords:
|
|
- Search Documentation
|
|
- Company Tickers
|
|
- Stock Market Search
|
|
- Search By Country
|
|
- Search By Sector
|
|
- Search By Industry
|
|
- Search By Exchange Country
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="stocks /search - Reference | OpenBB Terminal Docs" />
|
|
|
|
Show companies matching the search query
|
|
|
|
### Usage
|
|
|
|
```python
|
|
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 |
|
|
|
|
---
|