Spiral gives your agent every tool with one account. Browse the tools →

VS Code · Finance

How to Use B3 company details in VS Code

Returns a listed company's profile, sector classification, and optional financial summary. Use it to research an identified issuer after finding it through B3 company search.

Prompts to try with B3 company details in VS Code

Copy an example into VS Code, or ask in your own words.

Use B3 company details to retrieve Vale's profile, sector classification, and financial summary, then populate my research table.

B3 company detailsVS Code
Try asking
  • Use B3 company details to look this up and give me the result as a table. Save the result in ./assets.

  • Pull the latest numbers from B3 company details and tell me what changed since last week.

  • Check B3 company details and summarize what you find in three bullet points.

  • Pull the newest data from B3 company details and give me the result as a table.

How to set up B3 company details in VS Code

Pick the way that suits you. Each takes about two minutes.

Use Spiral's MCP server

  1. Add the hosted server

    Use Add to VS Code on the console's Agents & MCP page, or run:

    code --add-mcp '{"name":"spiral","type":"http","url":"https://api.spiral.ai/mcp"}'
  2. Sign in

    VS Code asks you to sign in when it first starts the server: sign in to Spiral and click Authorize. No API key. Run MCP: List Servers from the Command Palette to check that Spiral is running.

Use the Spiral skill

  1. Send VS Code this message

    Your agent reads Spiral's skill and sets itself up.

    set up https://spiral.ai/SKILL.md
  2. Sign in or paste a key

    Approve Spiral in the browser, or give the agent a key from the console.

Use the Spiral CLI

  1. Install and sign in

    Installs the Spiral CLI, signs you in and adds its skill to your coding agents.

    npx -y spiral-cli@latest init

Call the Spiral API

  1. Create an API key

    In the console, under API keys.

  2. Run B3 company details

    One request; the result comes back by polling or a webhook.

    curl https://api.spiral.ai/v1/runs \
      -H "Authorization: Bearer $SPIRAL_API_KEY" \
      -H "Content-Type: application/json" \
      -H "Idempotency-Key: $(uuidgen)" \
      -d '{
        "provider": "alexandria",
        "model": "b3-com-br/companies/company",
        "input": {
          "code_cvm": "<code_cvm>"
        }
      }'

Then paste one of the prompts above: VS Code finds B3 company details on Spiral, shows the price and runs it.

B3 company details providers and prices

Spiral runs B3 company details through Alexandria. Open a card for today's price, with every fee included.

AlexandriaFinance

Settings you can ask for

Ask VS Code for any of these in your prompt.

SettingAllowed valuesDefaultDescription
Include financialson or off

Also fetch the economic-financial summary (one more request).

Every API field of B3 listed companies and indices · Company is on its tool page: open its card above.

What can you do with B3 company details in VS Code?

Build a B3 research table backed by exchange records. Add company, disclosure, distribution, sector, quote, or index data to the part of your project that needs it.

Prepare an issuer research brief

Identify Petrobras, review its company profile, sector, disclosures, corporate events, cash distributions, delayed quote, and index inclusion in one personal research brief.

Inspect benchmark concentration

Review IBOV holdings and weights, identify the issuers, group them using B3 sectors, and add delayed quotes and other index associations for context.

Review a company's cash distributions

Resolve Vale's issuer identity and examine cash distribution history alongside company details, regulatory disclosures, corporate actions, and a delayed market quote.

Compare sector peers

Use B3 classifications to organize a peer comparison, then compare issuer profiles, financial summaries, payouts, disclosures, corporate events, and delayed quotes.

Research index composition changes

Compare saved IBOV holdings with the latest composition, identify affected issuers and sectors, and review their index inclusion, disclosures, and corporate actions.

Maintain a personal market review

Review a watchlist against its benchmark, combining company identities, sectors, disclosures, corporate events, payouts, index inclusion, holdings, and delayed quotes.

Reconcile securities with issuers

Check that securities in an IBOV research table map to the intended companies, then inspect company details, corporate actions, quotes, and index associations for inconsistencies.

Study a dividend benchmark

Inspect IDIV holdings and sector composition, then research constituent companies through payout histories, disclosures, corporate events, delayed quotes, and index inclusion.

Questions about B3 company details in VS Code

Can VS Code use B3 company details?

Yes. Add Spiral to VS Code as an MCP server, and VS Code can find and run B3 company details like any built-in tool.

How much does B3 company details cost in VS Code?

$0.00873 per call. You pay from your Spiral balance as you go, with no subscription, and a failed run is not charged. Your VS Code plan is separate.

Do I need an Alexandria account to use B3 company details in VS Code?

No. Spiral runs B3 company details on its own Alexandria account. You sign in to Spiral once and never paste a key.

How long does it take to set up B3 company details in VS Code?

About two minutes: add the hosted server, then sign in.

Does VS Code wait while B3 company details runs?

B3 company details runs in the background. VS Code starts the run, checks on it and gives you the json when it's ready.

What does this B3 data cover?

It covers B3 listed-company records and related disclosures, corporate actions, cash distributions, indices, and delayed quotes. Company registry coverage is tied to B3 listings.

Is this public company information?

Yes. The connector reads public B3 data, including issuer disclosures; Empresas.Net is provided jointly by CVM and B3 for publicly held companies and institutions responsible for BDR programs.

Are B3's labels translated into English?

The connector preserves Portuguese labels as B3 publishes them. Expect source terminology in company, sector, and corporate event records.

Does B3 guarantee that its website data is complete and current?

No. B3's terms disclaim guarantees for timeliness, completeness, accuracy, and updates to website information.

Can I reuse B3 website data commercially?

B3's website terms require prior written consent for commercial use of its data. Public availability does not grant unrestricted commercial reuse.

Get started

Start using B3 company details in VS Code

One Spiral account for every tool your agent needs. No subscription; you pay per run.

Paste this into VS Code:

Set up VS Code

set up https://spiral.ai/SKILL.md
Are you an AI agent? See setup options