{"openapi":"3.1.0","info":{"title":"B3 Brazil Stock Exchange API","version":"1.0.0","description":"Live data from B3 (Brasil Bolsa Balcão), Latin America's largest stock exchange, with no key. Read the live snapshot for any ticker (close, day change, volume, market cap, sector); pull a sector-classified ranking of every listed stock, fund and BDR (by market cap or volume, filterable by sector and instrument type); list the B3 sectors and instrument types; and read the market indexes B3 tracks. The Brazil-equities / sector / market-cap-ranking layer for trading dashboards, screeners and fintech — distinct from other exchange readers, with a dedicated sector-classification cut. Live from the public brapi feed; short cache only.","contact":{"name":"PremiumApi","url":"https://www.oanor.com/by/premiumapi"}},"servers":[{"url":"https://api.oanor.com/b3-api","description":"oanor gateway"}],"tags":[{"name":"Stocks"},{"name":"Market"},{"name":"Reference"},{"name":"Meta"}],"components":{"securitySchemes":{"oanorKey":{"type":"apiKey","in":"header","name":"x-oanor-key","description":"Get your key at https://www.oanor.com/developer/keys"}}},"security":[{"oanorKey":[]}],"paths":{"/v1/quote":{"get":{"operationId":"get_v1_quote","tags":["Stocks"],"summary":"Live snapshot for one or more tickers","description":"","parameters":[{"name":"tickers","in":"query","required":true,"description":"B3 tickers, comma-separated, e.g. PETR4,VALE3,ITUB4","schema":{"type":"string"},"example":"PETR4,VALE3"}],"security":[{"oanorKey":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"data":{"note":"The live snapshot for one or more B3 tickers — close, day change percent, volume, market cap and sector each. Pass tickers (comma-separate up to 10, e.g. PETR4,VALE3,ITUB4). For the whole market ranked, use /v1/list.","count":2,"quotes":[{"logo":"https://icons.brapi.dev/icons/PETR4.svg","name":"PETROLEO BRASILEIRO S.A. PETROBRAS","type":"stock","close":41.18,"sector":"Energy Minerals","ticker":"PETR4","volume":34024700,"market_cap":570094845993,"change_percent":-1.39},{"logo":"https://icons.brapi.dev/icons/VALE3.svg","name":"VALE S.A.","type":"stock","close":79.17,"sector":"Non-Energy Minerals","ticker":"VALE3","volume":12104500,"market_cap":328511788473,"change_percent":0.47}],"source":"B3"},"meta":{"timestamp":"2026-06-15T02:11:11.054Z","request_id":"6e0cb893-1b77-4fd1-a492-a91df7e36dbc"},"status":"ok","message":"Quote retrieved successfully","success":true}}}},"401":{"description":"Missing or invalid x-oanor-key header"},"402":{"description":"Active subscription required"},"429":{"description":"Rate-limit or monthly quota reached"},"502":{"description":"Upstream did not respond"}}}},"/v1/list":{"get":{"operationId":"get_v1_list","tags":["Market"],"summary":"Sector-classified market ranking","description":"","parameters":[{"name":"sort_by","in":"query","required":false,"description":"market_cap_basic, volume, close, change or name","schema":{"type":"string"},"example":"market_cap_basic"},{"name":"sort_order","in":"query","required":false,"description":"desc or asc (default desc)","schema":{"type":"string"},"example":"desc"},{"name":"sector","in":"query","required":false,"description":"Filter by sector (see /v1/sectors)","schema":{"type":"string"},"example":"Finance"},{"name":"type","in":"query","required":false,"description":"stock, fund or bdr","schema":{"type":"string"},"example":"stock"},{"name":"limit","in":"query","required":false,"description":"Results (1-100, default 30)","schema":{"type":"string"},"example":"30"}],"security":[{"oanorKey":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"data":{"note":"A sector-classified ranking of B3-listed instruments — each stock, fund or BDR with its close, day change, volume, market cap and sector. Sort by market_cap_basic (default), volume, close, change or name; filter by sector (see /v1/sectors) and type (stock|fund|bdr); page with limit. The Brazil market screen.","type":"stock","count":30,"sector":"Finance","source":"B3","stocks":[{"logo":"https://icons.brapi.dev/icons/ITUB4.svg","name":"ITAU UNIBANCO HOLDING S.A.","type":"stock","close":40.6,"sector":"Finance","ticker":"ITUB4","volume":30645500,"market_cap":457234880932,"change_percent":0.25},{"logo":"https://icons.brapi.dev/icons/ITUB3.svg","name":"ITAU UNIBANCO HOLDING S.A.","type":"stock","close":41.88,"sector":"Finance","ticker":"ITUB3","volume":2372800,"market_cap":457234880932,"change_percent":-1.62},{"logo":"https://icons.brapi.dev/icons/BRAPI.svg","name":"ITAU UNIBANCO HOLDING S.A.","type":"stock","close":40.5,"sector":"Finance","ticker":"ITUB4F","volume":62554,"market_cap":457234880932,"change_percent":0.05},{"logo":"https://icons.brapi.dev/icons/BRAPI.svg","name":"ITAU UNIBANCO HOLDING S.A.","type":"stock","close":42.05,"sector":"Finance","ticker":"ITUB3F","volume":13302,"market_cap":457234880932,"change_percent":-1.29},{"logo":"https://icons.brapi.dev/icons/BPAC3.svg","name":"BCO BTG PACTUAL S.A.","type":"stock","close":21.86,"sector":"Finance","ticker":"BPAC3","volume":32800,"market_cap":196368270176,"change_percent":0.37},{"logo":"https://icons.brapi.dev/icons/BRAPI.svg","name":"BCO BTG PACTUAL S.A.","type":"stock","close":17.29,"sector":"Finance","ticker":"BPAC5","volume":20300,"market_cap":196368270176,"change_percent":1.11},{"logo":"https://icons.brapi.dev/icons/BRAPI.svg","name":"BCO BTG PACTUAL S.A.","type":"stock","close":21.6,"sector":"Finance","ticker":"BPAC3F","volume":2870,"market_cap":196368270176,"change_percent":-1.77},{"logo":"https://icons.brapi.dev/icons/BRAPI.svg","name":"BCO BTG PACTUAL S.A.","type":"stock","close":17.01,"sector":"Finance","ticker":"BPAC5F","volume":393,"market_cap":196368270176,"change_percent":-0.23},{"logo":"https://icons.brapi.dev/icons/BBDC4.svg","name":"BCO BRADESCO S.A.","type":"stock","close":17.8,"sector":"Finance","ticker":"BBDC4","volume":22070300,"market_cap":174797203068,"change_percent":0.68},{"logo":"https://icons.brapi.dev/icons/BBDC3.svg","name":"BCO BRADESCO S.A.","type":"stock","close":15.5,"sector":"Finance","ticker":"BBDC3","volume":3850400,"market_cap":174797203068,"change_percent":0.52},{"logo":"https://icons.brapi.dev/icons/BRAPI.svg","name":"BCO BRADESCO S.A.","type":"stock","close":17.85,"sector":"Finance","ticker":"BBDC4F","volume":41160,"market_cap":174797203068,"change_percent":0.96},{"logo":"https://icons.brapi.dev/icons/BRAPI.svg","name":"BCO BRADESCO S.A.","type":"stock","close":15.5,"sector":"Finance","ticker":"BBDC3F","volume":22532,"market_cap":174797203068,"change_percent":0},{"logo":"https://icons.brapi.dev/icons/BRAPI.svg","name":"ITAUSA S.A.","type":"stock","close":12.9,"sector":"Finance","ticker":"ITSA4","volume":31989300,"market_cap":144999970579,"change_percent":-0.23},{"logo":"https://icons.brapi.dev/icons/ITSA3.svg","name":"ITAUSA S.A.","type":"stock","close":12.95,"sector":"Finance","ticker":"ITSA3","volume":104900,"market_cap":144999970579,"change_percent":-0.08},{"logo":"https://icons.brapi.dev/icons/BRAPI.svg","name":"ITAUSA S.A.","type":"stock","close":12.92,"sector":"Finance","ticker":"ITSA4F","volume":82029,"market_cap":144999970579,"change_percent":-0.23},{"logo":"https://icons.brapi.dev/icons/BRAPI.svg","name":"ITAUSA S.A.","type":"stock","close":12.95,"sector":"Finance","ticker":"ITSA3F","volume":10051,"market_cap":144999970579,"change_percent":-0.31},{"logo":"https://icons.brapi.dev/icons/BBAS3.svg","name":"BCO BRASIL S.A.","type":"stock","close":19.46,"sector":"Finance","ticker":"BBAS3","volume":13741700,"market_cap":111002225573,"change_percent":0.26},{"logo":"https://icons.brapi.dev/icons/BRAPI.svg","name":"BCO BRASIL S.A.","type":"stock","close":19.49,"sector":"Finance","ticker":"BBAS3F","volume":272525,"market_cap":111002225573,"change_percent":0.36},{"logo":"https://icons.brapi.dev/icons/BRAPI.svg","name":"BCO SANTANDER (BRASIL) S.A.","type":"stock","close":14.18,"sector":"Finance","ticker":"SANB4","volume":45100,"market_cap":101867546352,"change_percent":0.64},{"logo":"https://icons.brapi.dev/icons/SANB3.svg","name":"BCO SANTANDER (BRASIL) S.A.","type":"stock","close":13.19,"sector":"Finance","ticker":"SANB3","volume":36300,"market_cap":101867546352,"change_percent":0.76},{"logo":"https://icons.brapi.dev/icons/BRAPI.svg","name":"BCO SANTANDER (BRASIL) S.A.","type":"stock","close":14.25,"sector":"Finance","ticker":"SANB4F","volume":5369,"market_cap":101867546352,"change_percent":0.21},{"logo":"https://icons.brapi.dev/icons/BRAPI.svg","name":"BCO SANTANDER (BRASIL) S.A.","type":"stock","close":13.16,"sector":"Finance","ticker":"SANB3F","volume":5076,"market_cap":101867546352,"change_percent":-0.53},{"logo":"https://icons.brapi.dev/icons/B3SA3.svg","name":"B3 S.A. - BRASIL. BOLSA. BALCÃO","type":"stock","close":15.23,"sector":"Finance","ticker":"B3SA3","volume":46557500,"market_cap":75015132414,"change_percent":-1.36},{"logo":"https://icons.brapi.dev/icons/BRAPI.svg","name":"B3 S.A. - BRASIL. BOLSA. BALCÃO","type":"stock","close":15.19,"sector":"Finance","ticker":"B3SA3F","volume":31499,"market_cap":75015132414,"change_percent":-1.56},{"logo":"https://icons.brapi.dev/icons/BBSE3.svg","name":"BB SEGURIDADE PARTICIPAÇÕES S.A.","type":"stock","close":37.87,"sector":"Finance","ticker":"BBSE3","volume":13723300,"market_cap":73259670030,"change_percent":0.19},{"logo":"https://icons.brapi.dev/icons/BRAPI.svg","name":"BB SEGURIDADE PARTICIPAÇÕES S.A.","type":"stock","close":37.73,"sector":"Finance","ticker":"BBSE3F","volume":72898,"market_cap":73259670030,"change_percent":-0.4},{"logo":"https://icons.brapi.dev/icons/CXSE3.svg","name":"CAIXA SEGURIDADE PARTICIPAÇÕES S.A.","type":"stock","close":18.6,"sector":"Finance","ticker":"CXSE3","volume":2892800,"market_cap":55919998169,"change_percent":-0.21},{"logo":"https://icons.brapi.dev/icons/BRAPI.svg","name":"CAIXA SEGURIDADE PARTICIPAÇÕES S.A.","type":"stock","close":18.61,"sector":"Finance","ticker":"CXSE3F","volume":43482,"market_cap":55919998169,"change_percent":-0.48},{"logo":"https://icons.brapi.dev/icons/RENT3.svg","name":"LOCALIZA RENT A CAR S.A.","type":"stock","close":40.7,"sector":"Finance","ticker":"RENT3","volume":8442200,"market_cap":43914888925,"change_percent":-0.25},{"logo":"https://icons.brapi.dev/icons/BRAPI.svg","name":"LOCALIZA RENT A CAR S.A.","type":"stock","close":39.23,"sector":"Finance","ticker":"RENT4","volume":18300,"market_cap":43914888925,"change_percent":-0.81}],"sort_by":"market_cap_basic","sort_order":"desc"},"meta":{"timestamp":"2026-06-15T02:11:12.140Z","request_id":"1eab60c7-9618-4992-b37d-f54b2c2a0b53"},"status":"ok","message":"Market list retrieved successfully","success":true}}}},"401":{"description":"Missing or invalid x-oanor-key header"},"402":{"description":"Active subscription required"},"429":{"description":"Rate-limit or monthly quota reached"},"502":{"description":"Upstream did not respond"}}}},"/v1/indexes":{"get":{"operationId":"get_v1_indexes","tags":["Reference"],"summary":"Market indexes B3 tracks","description":"","parameters":[],"security":[{"oanorKey":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"data":{"note":"The market indexes B3's feed tracks — each with its symbol and name (e.g. ^BVSP for the Ibovespa). Pass an index symbol to /v1/quote to read its level.","count":1,"source":"B3","indexes":[{"name":"IBOVESPA","symbol":"^BVSP"}]},"meta":{"timestamp":"2026-06-15T02:11:12.398Z","request_id":"c50a0ed4-639c-4cfd-817f-44f6724e6b30"},"status":"ok","message":"Indexes retrieved successfully","success":true}}}},"401":{"description":"Missing or invalid x-oanor-key header"},"402":{"description":"Active subscription required"},"429":{"description":"Rate-limit or monthly quota reached"},"502":{"description":"Upstream did not respond"}}}},"/v1/sectors":{"get":{"operationId":"get_v1_sectors","tags":["Reference"],"summary":"B3 sectors & instrument types","description":"","parameters":[],"security":[{"oanorKey":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"data":{"note":"The sectors and instrument types available on B3 — pass a sector to /v1/list (filter) and a type (stock, fund or BDR). Use these to slice the market by industry.","source":"B3","sectors":["Retail Trade","Energy Minerals","Health Services","Utilities","Finance","Consumer Services","Consumer Non-Durables","Non-Energy Minerals","Commercial Services","Distribution Services","Transportation","Technology Services","Process Industries","Communications","Producer Manufacturing","Miscellaneous","Electronic Technology","Industrial Services","Health Technology","Consumer Durables"],"stock_types":["stock","fund","bdr"]},"meta":{"timestamp":"2026-06-15T02:11:12.485Z","request_id":"c5aea996-1a75-40f3-ac7a-447a1b2d028d"},"status":"ok","message":"Sectors retrieved successfully","success":true}}}},"401":{"description":"Missing or invalid x-oanor-key header"},"402":{"description":"Active subscription required"},"429":{"description":"Rate-limit or monthly quota reached"},"502":{"description":"Upstream did not respond"}}}},"/v1/meta":{"get":{"operationId":"get_v1_meta","tags":["Meta"],"summary":"Endpoints & source","description":"","parameters":[],"security":[{"oanorKey":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"data":{"sample":{"petr4_close":41.18},"source":"brapi public B3 market API (brapi.dev), keyless","service":"b3-api","endpoints":{"GET /v1/list":"Sector-classified market ranking (sort_by, sector, type, limit).","GET /v1/meta":"This document.","GET /v1/quote":"Live quote for one or more tickers (tickers, comma-separated).","GET /v1/indexes":"The market indexes B3 tracks.","GET /v1/sectors":"The B3 sectors and instrument types."},"description":"Live data from B3 (Brasil Bolsa Balcão), Latin America's largest exchange, with no key: the live snapshot for any ticker (close, change, volume, market cap, sector), a sector-classified market ranking of every stock, fund and BDR, the B3 sectors and instrument types, and the world indexes B3 tracks. The Brazil-equities / sector / market-cap-ranking layer for trading dashboards and screeners. Distinct from other exchange readers — B3 data with a sector cut. Live, short cache only.","upstream_status":"ok"},"meta":{"timestamp":"2026-06-15T02:11:12.553Z","request_id":"6adb8e8d-41c4-4ac5-8392-840857edf00a"},"status":"ok","message":"Meta","success":true}}}},"401":{"description":"Missing or invalid x-oanor-key header"},"402":{"description":"Active subscription required"},"429":{"description":"Rate-limit or monthly quota reached"},"502":{"description":"Upstream did not respond"}}}}},"x-oanor-pricing":[{"slug":"free","name":"Free","price_cents_month":0,"monthly_call_quota":18000,"rps_limit":3,"hard_limit":true},{"slug":"starter","name":"Starter","price_cents_month":1940,"monthly_call_quota":350000,"rps_limit":8,"hard_limit":true},{"slug":"pro","name":"Pro","price_cents_month":5100,"monthly_call_quota":1850000,"rps_limit":20,"hard_limit":true},{"slug":"enterprise","name":"Enterprise","price_cents_month":12400,"monthly_call_quota":9400000,"rps_limit":60,"hard_limit":true}],"x-oanor-marketplace-url":"https://www.oanor.com/api/b3-api"}