{
  "_id": "69e0762fc5259ad4cd8fe365",
  "Package": "rb3",
  "Title": "Download and Parse Public Data Released by B3 Exchange",
  "Description": "Download and parse public files released by B3 and convert\nthem into useful formats and data structures common to data\nanalysis practitioners.",
  "Version": "0.1.0",
  "Authors@R": "c(person(\"Wilson\", \"Freitas\",\nemail = \"wilson.freitas@gmail.com\",\nrole = c(\"aut\", \"cre\")),\nperson(\"Marcelo\", \"Perlin\",\nemail = \"marceloperlin@gmail.com\",\nrole = \"aut\"))",
  "License": "MIT + file LICENSE",
  "Collate": "'types.R' 'fields.R' 'registry.R' 'template.R' 'meta.R'\n'read-marketdata.R' 'fetch-marketdata.R'\n'download-marketdata.R' 'scraper-futures.R'\n'scraper-cotahist.R' 'scraper-yc.R' 'scraper-indexes.R'\n'readers.R' 'downloaders.R' 'rb3-package.R' 'zzz.R'",
  "BugReports": "https://github.com/ropensci/rb3/issues",
  "URL": "https://github.com/ropensci/rb3, https://ropensci.github.io/rb3/",
  "VignetteBuilder": "knitr",
  "Roxygen": "list(markdown = TRUE)",
  "RoxygenNote": "7.3.2",
  "Config/testthat/edition": "3",
  "Encoding": "UTF-8",
  "Config/pak/sysreqs": "cmake libicu-dev libxml2-dev libssl-dev libx11-dev",
  "Repository": "https://ropensci.r-universe.dev",
  "Date/Publication": "2025-11-01 11:06:29 UTC",
  "RemoteUrl": "https://github.com/ropensci/rb3",
  "RemoteRef": "main",
  "RemoteSha": "ef11508519ac018491b3d3d4e348ceb23ee191de",
  "NeedsCompilation": "no",
  "Packaged": {
    "Date": "2026-04-15 08:00:39 UTC",
    "User": "root"
  },
  "Author": "Wilson Freitas [aut, cre],\nMarcelo Perlin [aut]",
  "Maintainer": "Wilson Freitas <wilson.freitas@gmail.com>",
  "MD5sum": "dbe7d3ee7bbf8d1a27a9a4d9fbb95658",
  "_user": "ropensci",
  "_type": "src",
  "_file": "rb3_0.1.0.tar.gz",
  "_fileid": "8d22a3c82c5de8c11270e9a8bc2e09a933864332f80461cc135690be920e8175",
  "_filesize": 5315841,
  "_sha256": "8d22a3c82c5de8c11270e9a8bc2e09a933864332f80461cc135690be920e8175",
  "_created": "2026-04-15T08:00:39.000Z",
  "_published": "2026-04-16T05:39:59.447Z",
  "_distro": "noble",
  "_jobs": [
    {
      "job": 71579500138,
      "time": 162,
      "config": "linux-devel-x86_64",
      "r": "4.6.0",
      "check": "OK",
      "artifact": "6445727763"
    },
    {
      "job": 71579500089,
      "time": 160,
      "config": "linux-release-x86_64",
      "r": "4.5.3",
      "check": "OK",
      "artifact": "6445727724"
    },
    {
      "job": 71579499907,
      "time": 154,
      "config": "macos-oldrel-arm64",
      "r": "4.5.3",
      "check": "OK",
      "artifact": "6466694553"
    },
    {
      "job": 71579500252,
      "time": 114,
      "config": "macos-release-arm64",
      "r": "4.6.0",
      "check": "OK",
      "artifact": "6445714798"
    },
    {
      "job": 71579499903,
      "time": 200,
      "config": "pkgdown",
      "r": "4.5.2",
      "check": "OK",
      "artifact": "6445674020"
    },
    {
      "job": 71579499930,
      "time": 228,
      "config": "source",
      "r": "4.5.3",
      "check": "OK",
      "artifact": "6445682166"
    },
    {
      "job": 71579500285,
      "time": 136,
      "config": "wasm-release",
      "r": "4.5.1",
      "check": "OK",
      "artifact": "6445721030"
    },
    {
      "job": 71579500298,
      "time": 192,
      "config": "windows-devel",
      "r": "4.7.0",
      "check": "OK",
      "artifact": "6445736122"
    },
    {
      "job": 71579500322,
      "time": 139,
      "config": "windows-oldrel",
      "r": "4.5.3",
      "check": "OK",
      "artifact": "6445721733"
    },
    {
      "job": 71579500059,
      "time": 161,
      "config": "windows-release",
      "r": "4.6.0",
      "check": "OK",
      "artifact": "6445727727"
    }
  ],
  "_buildurl": "https://github.com/r-universe/ropensci/actions/runs/24443113459",
  "_status": "success",
  "_host": "GitHub-Actions",
  "_upstream": "https://github.com/ropensci/rb3",
  "_commit": {
    "id": "ef11508519ac018491b3d3d4e348ceb23ee191de",
    "author": "Wilson Freitas <wilson.freitas@gmail.com>",
    "committer": "GitHub <noreply@github.com>",
    "message": "Merge pull request #122 from miceli/main\n\nUpdate scraper-cotahist.R",
    "time": 1761995189
  },
  "_maintainer": {
    "name": "Wilson Freitas",
    "email": "wilson.freitas@gmail.com",
    "login": "wilsonfreitas",
    "uuid": 1583922
  },
  "_registered": true,
  "_dependencies": [
    {
      "package": "R",
      "version": ">= 4.1.0",
      "role": "Depends"
    },
    {
      "package": "bizdays",
      "role": "Imports"
    },
    {
      "package": "stringr",
      "role": "Imports"
    },
    {
      "package": "stringi",
      "role": "Imports"
    },
    {
      "package": "cli",
      "role": "Imports"
    },
    {
      "package": "readr",
      "role": "Imports"
    },
    {
      "package": "dplyr",
      "role": "Imports"
    },
    {
      "package": "arrow",
      "role": "Imports"
    },
    {
      "package": "httr",
      "role": "Imports"
    },
    {
      "package": "jsonlite",
      "role": "Imports"
    },
    {
      "package": "purrr",
      "role": "Imports"
    },
    {
      "package": "rlang",
      "role": "Imports"
    },
    {
      "package": "yaml",
      "role": "Imports"
    },
    {
      "package": "digest",
      "role": "Imports"
    },
    {
      "package": "base64enc",
      "role": "Imports"
    },
    {
      "package": "XML",
      "role": "Imports"
    },
    {
      "package": "R.utils",
      "role": "Imports"
    },
    {
      "package": "lubridate",
      "role": "Imports"
    },
    {
      "package": "DBI",
      "role": "Imports"
    },
    {
      "package": "RSQLite",
      "role": "Imports"
    },
    {
      "package": "testthat",
      "role": "Suggests"
    },
    {
      "package": "knitr",
      "role": "Suggests"
    },
    {
      "package": "rmarkdown",
      "role": "Suggests"
    },
    {
      "package": "ggplot2",
      "role": "Suggests"
    },
    {
      "package": "covr",
      "role": "Suggests"
    },
    {
      "package": "scales",
      "role": "Suggests"
    },
    {
      "package": "magrittr",
      "role": "Suggests"
    },
    {
      "package": "tibble",
      "role": "Suggests"
    },
    {
      "package": "withr",
      "role": "Suggests"
    },
    {
      "package": "tidyr",
      "role": "Suggests"
    },
    {
      "package": "vcr",
      "version": ">= 0.6.0",
      "role": "Suggests"
    }
  ],
  "_owner": "ropensci",
  "_selfowned": true,
  "_usedby": 0,
  "_updates": [
    {
      "week": "2025-16",
      "n": 1
    },
    {
      "week": "2025-17",
      "n": 4
    },
    {
      "week": "2025-18",
      "n": 7
    },
    {
      "week": "2025-19",
      "n": 2
    },
    {
      "week": "2025-32",
      "n": 1
    },
    {
      "week": "2025-44",
      "n": 1
    }
  ],
  "_tags": [],
  "_topics": [
    "brazil",
    "exchange-data",
    "finance",
    "financial-data",
    "financial-services",
    "market-data"
  ],
  "_stars": 91,
  "_contributors": [
    {
      "user": "wilsonfreitas",
      "count": 704,
      "uuid": 1583922
    },
    {
      "user": "msperlin",
      "count": 34,
      "uuid": 10583352
    },
    {
      "user": "hugorteixeira",
      "count": 1,
      "uuid": 142823711
    },
    {
      "user": "miceli",
      "count": 1,
      "uuid": 911032
    }
  ],
  "_userbio": {
    "uuid": 1200269,
    "type": "organization",
    "name": "rOpenSci",
    "description": "Tools and R Packages for Open Science"
  },
  "_downloads": {
    "count": 521,
    "source": "https://cranlogs.r-pkg.org/downloads/total/last-month/rb3"
  },
  "_devurl": "https://github.com/ropensci/rb3",
  "_pkgdown": "https://docs.ropensci.org/rb3",
  "_searchresults": 79,
  "_metadata": {
    "review": {
      "id": 534,
      "status": "reviewed",
      "version": "0.0.3",
      "organization": "rOpenSci Software Review",
      "url": "https://github.com/ropensci/software-review/issues/534"
    },
    "ropensci_category": "data-access"
  },
  "_rbuild": "4.5.3",
  "_assets": [
    "extra/citation.cff",
    "extra/citation.html",
    "extra/citation.json",
    "extra/citation.txt",
    "extra/contents.json",
    "extra/NEWS.html",
    "extra/NEWS.txt",
    "extra/rb3.html",
    "extra/readme.html",
    "extra/readme.md",
    "manual.pdf"
  ],
  "_homeurl": "https://github.com/ropensci/rb3",
  "_realowner": "ropensci",
  "_cranurl": true,
  "_releases": [
    {
      "version": "0.0.1",
      "date": "2022-05-05"
    },
    {
      "version": "0.0.2",
      "date": "2022-05-10"
    },
    {
      "version": "0.0.3",
      "date": "2022-05-29"
    },
    {
      "version": "0.0.4",
      "date": "2022-06-22"
    },
    {
      "version": "0.0.5",
      "date": "2022-07-17"
    },
    {
      "version": "0.0.6",
      "date": "2022-08-19"
    },
    {
      "version": "0.0.7",
      "date": "2022-12-14"
    },
    {
      "version": "0.0.8",
      "date": "2023-03-06"
    },
    {
      "version": "0.0.9",
      "date": "2023-03-24"
    },
    {
      "version": "0.0.10",
      "date": "2023-04-14"
    },
    {
      "version": "0.0.11",
      "date": "2024-07-13"
    },
    {
      "version": "0.0.12",
      "date": "2025-02-18"
    },
    {
      "version": "0.1.0",
      "date": "2025-07-07"
    }
  ],
  "_exports": [
    "code2month",
    "cotahist_filter_bdr",
    "cotahist_filter_equity",
    "cotahist_filter_equity_options",
    "cotahist_filter_etf",
    "cotahist_filter_fiagro",
    "cotahist_filter_fidc",
    "cotahist_filter_fii",
    "cotahist_filter_fund_options",
    "cotahist_filter_index",
    "cotahist_filter_index_options",
    "cotahist_filter_unit",
    "cotahist_get",
    "cotahist_options_by_symbols_get",
    "download_marketdata",
    "fetch_marketdata",
    "futures_get",
    "indexes_composition_get",
    "indexes_current_portfolio_get",
    "indexes_get",
    "indexes_historical_data_get",
    "indexes_theoretical_portfolio_get",
    "list_templates",
    "maturitycode2date",
    "meta_db_connection",
    "rb3_bootstrap",
    "read_marketdata",
    "template_dataset",
    "template_meta_create_or_load",
    "template_meta_load",
    "template_meta_new",
    "template_retrieve",
    "yc_brl_get",
    "yc_brl_with_futures_get",
    "yc_get",
    "yc_ipca_get",
    "yc_ipca_with_futures_get",
    "yc_usd_get",
    "yc_usd_with_futures_get"
  ],
  "_help": [
    {
      "page": "code2month",
      "title": "Convert Maturity Code to Corresponding Month",
      "topics": [
        "code2month"
      ]
    },
    {
      "page": "cotahist_get",
      "title": "Access COTAHIST datasets",
      "topics": [
        "cotahist_get"
      ]
    },
    {
      "page": "cotahist-extracts",
      "title": "Filtering data from COTAHIST datasets",
      "topics": [
        "cotahist-extracts",
        "cotahist_filter_bdr",
        "cotahist_filter_equity",
        "cotahist_filter_equity_options",
        "cotahist_filter_etf",
        "cotahist_filter_fiagro",
        "cotahist_filter_fidc",
        "cotahist_filter_fii",
        "cotahist_filter_fund_options",
        "cotahist_filter_index",
        "cotahist_filter_index_options",
        "cotahist_filter_unit"
      ]
    },
    {
      "page": "download_marketdata",
      "title": "Download Raw Market Data Files from B3",
      "topics": [
        "download_marketdata"
      ]
    },
    {
      "page": "fetch_marketdata",
      "title": "Fetch and process market data",
      "topics": [
        "fetch_marketdata"
      ]
    },
    {
      "page": "futures_get",
      "title": "Retrieves B3 Futures Settlement Prices",
      "topics": [
        "futures_get"
      ]
    },
    {
      "page": "indexes_composition_get",
      "title": "Retrieve Composition of B3 Indexes",
      "topics": [
        "indexes_composition_get"
      ]
    },
    {
      "page": "indexes_get",
      "title": "Get B3 indexes available",
      "topics": [
        "indexes_get"
      ]
    },
    {
      "page": "indexes_historical_data_get",
      "title": "Get historical data from B3 indexes",
      "topics": [
        "indexes_historical_data_get"
      ]
    },
    {
      "page": "indexes-portfolio",
      "title": "Retrieve Portfolio of B3 Indexes",
      "topics": [
        "indexes-portfolio",
        "indexes_current_portfolio_get",
        "indexes_theoretical_portfolio_get"
      ]
    },
    {
      "page": "list_templates",
      "title": "List Available Templates",
      "topics": [
        "list_templates"
      ]
    },
    {
      "page": "maturitycode2date",
      "title": "Convert Maturity Code to Date",
      "topics": [
        "maturitycode2date"
      ]
    },
    {
      "page": "meta_db_connection",
      "title": "Returns a SQLite Database Connection for the RB3 Package Metadata",
      "topics": [
        "meta_db_connection"
      ]
    },
    {
      "page": "rb3_bootstrap",
      "title": "Initialize the rb3 package cache folders",
      "topics": [
        "rb3_bootstrap"
      ]
    },
    {
      "page": "rb3.cachedir",
      "title": "'rb3.cachedir' Option",
      "topics": [
        "rb3.cachedir"
      ]
    },
    {
      "page": "read_marketdata",
      "title": "Read and parse raw market data files downloaded from the B3 website.",
      "topics": [
        "read_marketdata"
      ]
    },
    {
      "page": "superdataset",
      "title": "Enhanced Dataset Creation",
      "topics": [
        "cotahist_options_by_symbols_get",
        "superdataset",
        "yc_brl_with_futures_get",
        "yc_ipca_with_futures_get",
        "yc_usd_with_futures_get"
      ]
    },
    {
      "page": "template_dataset",
      "title": "Access a Dataset for a Template",
      "topics": [
        "template_dataset"
      ]
    },
    {
      "page": "template_meta_create_or_load",
      "title": "Create or Load Template Metadata",
      "topics": [
        "template_meta_create_or_load",
        "template_meta_load",
        "template_meta_new"
      ]
    },
    {
      "page": "template_retrieve",
      "title": "Retrieve a template by its name",
      "topics": [
        "template_retrieve"
      ]
    },
    {
      "page": "yc_xxx_get",
      "title": "Retrieve Yield Curve Data",
      "topics": [
        "yc_brl_get",
        "yc_get",
        "yc_ipca_get",
        "yc_usd_get",
        "yc_xxx_get"
      ]
    }
  ],
  "_pkglogo": "https://github.com/ropensci/rb3/raw/main/man/figures/logo.png",
  "_readme": "https://github.com/ropensci/rb3/raw/main/README.md",
  "_rundeps": [
    "arrow",
    "askpass",
    "assertthat",
    "base64enc",
    "bit",
    "bit64",
    "bizdays",
    "blob",
    "cachem",
    "cli",
    "clipr",
    "cpp11",
    "crayon",
    "curl",
    "DBI",
    "digest",
    "dplyr",
    "fastmap",
    "generics",
    "glue",
    "hms",
    "httr",
    "jsonlite",
    "lifecycle",
    "lubridate",
    "magrittr",
    "memoise",
    "mime",
    "openssl",
    "pillar",
    "pkgconfig",
    "prettyunits",
    "progress",
    "purrr",
    "R.methodsS3",
    "R.oo",
    "R.utils",
    "R6",
    "readr",
    "rlang",
    "RSQLite",
    "stringi",
    "stringr",
    "sys",
    "tibble",
    "tidyselect",
    "timechange",
    "tzdb",
    "utf8",
    "vctrs",
    "vroom",
    "withr",
    "XML",
    "yaml"
  ],
  "_vignettes": [
    {
      "source": "Fetching-historical-index-data.Rmd",
      "filename": "Fetching-historical-index-data.html",
      "title": "Analyzing B3 Index Data",
      "engine": "knitr::rmarkdown",
      "headings": [
        "Introduction",
        "Retrieving available indices",
        "Fetching historical index data",
        "Visualizing index performance",
        "Analyzing index composition",
        "Finding stocks in multiple indices",
        "Finding which indices contain a specific stock",
        "Analyzing index weights with the theoretical portfolio",
        "Top constituents by weight",
        "Comparing index concentration",
        "Sector analysis with the current portfolio",
        "Sector composition analysis",
        "Creating helper functions for index analysis",
        "Analyzing index performance metrics",
        "Calculating summary statistics",
        "Conclusion"
      ],
      "created": "2025-04-14 08:46:07",
      "modified": "2025-04-14 08:46:07",
      "commits": 1
    },
    {
      "source": "Fetching-historical-yield-curve.Rmd",
      "filename": "Fetching-historical-yield-curve.html",
      "title": "Fetching B3 Yield Curves",
      "engine": "knitr::rmarkdown",
      "headings": [
        "Introduction",
        "Fetching the data",
        "Selecting Reference Dates",
        "2. Fetching and Storing Market Data",
        "PRE Curve (DI rates)",
        "IPCA Curve (DIC curve)",
        "Cupom Limpo (USD - DOC curve)",
        "Break-even Inflation: PRE vs DIC",
        "Conclusion"
      ],
      "created": "2022-04-16 14:43:22",
      "modified": "2025-04-14 08:46:07",
      "commits": 7
    },
    {
      "source": "Fetching-historical-equity-data.Rmd",
      "filename": "Fetching-historical-equity-data.html",
      "title": "Fetching Historical Equity Data",
      "engine": "knitr::rmarkdown",
      "headings": [
        "Introduction",
        "Fetching historical data",
        "Downloading yearly data",
        "Downloading daily data",
        "Accessing the datasets",
        "Filtering by asset type",
        "Equities",
        "ETFs (Exchange Traded Funds)",
        "REITs (FIIs - Fundos Imobiliários)",
        "BDRs (Brazilian Depositary Receipts)",
        "Other asset classes",
        "Analyzing equity data",
        "Top traded equities by volume",
        "ETF market share analysis",
        "Analyzing distribution IDs for price continuity",
        "Working with BDRs",
        "Conclusion"
      ],
      "created": "2025-04-14 08:46:07",
      "modified": "2025-04-14 08:46:07",
      "commits": 1
    },
    {
      "source": "Getting-started.Rmd",
      "filename": "Getting-started.html",
      "title": "Getting Started",
      "engine": "knitr::rmarkdown",
      "headings": [
        "Introduction",
        "Downloading Market Data",
        "Templates",
        "Fetching market data",
        "rb3.cachedir folder",
        "Note",
        "Accessing the data",
        "Conclusion"
      ],
      "created": "2025-04-14 08:46:07",
      "modified": "2025-04-28 09:42:51",
      "commits": 3
    },
    {
      "source": "Fetching-historical-future-rates.Rmd",
      "filename": "Fetching-historical-future-rates.html",
      "title": "How to Compute Historical Rates from B3 Future Prices",
      "engine": "knitr::rmarkdown",
      "headings": [
        "Introduction",
        "Fetching historical data",
        "Querying the data",
        "Historical nominal interest rates",
        "Historical real interest rates",
        "Implied inflation",
        "Forward rates",
        "Conclusion"
      ],
      "created": "2022-04-24 21:30:15",
      "modified": "2025-04-27 17:33:40",
      "commits": 15
    }
  ],
  "_score": 8.50988099738688,
  "_indexed": true,
  "_nocasepkg": "rb3",
  "_universes": [
    "ropensci",
    "wilsonfreitas"
  ],
  "_binaries": [
    {
      "r": "4.6.0",
      "os": "linux",
      "version": "0.1.0",
      "date": "2026-04-15T08:03:00.000Z",
      "distro": "noble",
      "commit": "ef11508519ac018491b3d3d4e348ceb23ee191de",
      "fileid": "d2a590f5325945cf15da4bc9ca03def59abc2400101fe929428eb80a3de6f5bf",
      "status": "success",
      "check": "OK",
      "buildurl": "https://github.com/r-universe/ropensci/actions/runs/24443113459"
    },
    {
      "r": "4.5.3",
      "os": "linux",
      "version": "0.1.0",
      "date": "2026-04-15T08:03:00.000Z",
      "distro": "noble",
      "commit": "ef11508519ac018491b3d3d4e348ceb23ee191de",
      "fileid": "0c2a5693b28cb7934eb9429341398f36e91c00c332bb4915ff7b451e69c695f2",
      "status": "success",
      "check": "OK",
      "buildurl": "https://github.com/r-universe/ropensci/actions/runs/24443113459"
    },
    {
      "r": "4.5.3",
      "os": "mac",
      "version": "0.1.0",
      "date": "2026-04-16T05:39:00.000Z",
      "commit": "ef11508519ac018491b3d3d4e348ceb23ee191de",
      "fileid": "62a63860fe8eac1b6c54b9ae4392094367b0f39c096f7ab1b4ade76b04302a0a",
      "status": "success",
      "check": "OK",
      "buildurl": "https://github.com/r-universe/ropensci/actions/runs/24443113459"
    },
    {
      "r": "4.6.0",
      "os": "mac",
      "version": "0.1.0",
      "date": "2026-04-15T08:02:26.000Z",
      "commit": "ef11508519ac018491b3d3d4e348ceb23ee191de",
      "fileid": "701d6c71eb978b4c57e300c39e4f1451ee44da1f3c5bc63d6f20a686352b708b",
      "status": "success",
      "check": "OK",
      "buildurl": "https://github.com/r-universe/ropensci/actions/runs/24443113459"
    },
    {
      "r": "4.5.1",
      "os": "wasm",
      "version": "0.1.0",
      "date": "2026-04-15T08:03:15.000Z",
      "commit": "ef11508519ac018491b3d3d4e348ceb23ee191de",
      "fileid": "01c510e41033c478f83741f63475c0da35a199e4eaa32da7a78ba5cf1a6ed4e5",
      "status": "success",
      "buildurl": "https://github.com/r-universe/ropensci/actions/runs/24443113459"
    },
    {
      "r": "4.7.0",
      "os": "win",
      "version": "0.1.0",
      "date": "2026-04-15T08:02:06.000Z",
      "commit": "ef11508519ac018491b3d3d4e348ceb23ee191de",
      "fileid": "fc344b48c1394bb08ef4cf2b553dd65e4fadebfec69050a105c4b9483ea295bd",
      "status": "success",
      "check": "OK",
      "buildurl": "https://github.com/r-universe/ropensci/actions/runs/24443113459"
    },
    {
      "r": "4.5.3",
      "os": "win",
      "version": "0.1.0",
      "date": "2026-04-15T08:02:00.000Z",
      "commit": "ef11508519ac018491b3d3d4e348ceb23ee191de",
      "fileid": "049318d78795d7817891057f7945e3b026d3aeca258f8bf321d7388dabbb06fc",
      "status": "success",
      "check": "OK",
      "buildurl": "https://github.com/r-universe/ropensci/actions/runs/24443113459"
    },
    {
      "r": "4.6.0",
      "os": "win",
      "version": "0.1.0",
      "date": "2026-04-15T08:02:15.000Z",
      "commit": "ef11508519ac018491b3d3d4e348ceb23ee191de",
      "fileid": "5903b04a51f660d4e64ea1dc340b6ef4293fa9b9faf8766c2021b193d14c7a46",
      "status": "success",
      "check": "OK",
      "buildurl": "https://github.com/r-universe/ropensci/actions/runs/24443113459"
    }
  ]
}