{"id":7927,"date":"2024-03-01T22:40:11","date_gmt":"2024-03-01T22:40:11","guid":{"rendered":"https:\/\/professional.content.cirrus.bloomberg.com\/professional2023\/support\/api-library\/"},"modified":"2026-01-12T14:59:09","modified_gmt":"2026-01-12T19:59:09","slug":"api-library","status":"publish","type":"page","link":"https:\/\/professional.content.cirrus.bloomberg.com\/professional2023\/support\/api-library\/","title":{"rendered":"API Library"},"content":{"rendered":"
\n
\n \n \n \n \n \n
\n Support<\/a><\/span>\n API Library<\/span>\n <\/div>\n\n<\/div>\n\t

API Library<\/h1>\n\n<\/div>\n\n<\/div>\n\n<\/div>\n\n\n <\/div>\n <\/section>\n<\/div>\n\n
\n
\n \n \n \n \n

\n \n\t

Notes<\/h2>\n\n<\/div>\n\n\n<\/div>\n

\n\t

Supported Releases<\/strong>: These releases have been certified by Bloomberg\u2019s Enterprise Products team for use by Bloomberg customers.<\/p>\n\n<\/div>\n\n\t

Experimental Releases<\/strong>: These releases have not yet been certified for use by Bloomberg customers, but have been released by the API library engineering team in order to address specific issues or add new features. Bloomberg customers should not use these releases unless specifically directed to do so.<\/p>\n\n<\/div>\n\n<\/div>\n\n\n <\/div>\n <\/section>\n<\/div>\n\n

\n
\n \n \n \n \n \n
\n\n\n<\/div>\n\n\n <\/div>\n <\/section>\n<\/div>\n\n
\n
\n \n \n \n \n \n

\n\n\t\n\t\t\n\t\t\t
Documentation: The BLPAPI Developer\u2019s Guide is a tutorial for developing applications with BLPAPI in C++, Java and C# (.NET). It documents how the SDK libraries connect to the Bloomberg network, data schemas, events and messages, and much more.<\/td>\n\t\t<\/tr>\n\t<\/tbody>\n<\/table>\n\n\n\t\n\t\t\n\t\t\t
API Windows<\/td>\n\t\t<\/tr>\n\t<\/tbody>\n<\/table>\n\n\n\t\n\t\t\n\t\t\t
API Linux: These Bloomberg API libraries cannot be used by Bloomberg Professional terminal users (which use the Desktop API). They are only compatible with the Bloomberg Server API and B-Pipe data feed products.<\/td>\n\t\t<\/tr>\n\t<\/tbody>\n<\/table>\n\n\n\t\n\t\t\n\t\t\t
API macOS ARM: These Bloomberg API libraries cannot be used by Bloomberg Professional terminal users (which use the Desktop API). They are only compatible with the Bloomberg Server API and B-Pipe data feed products.<\/td>\n\t\t<\/tr>\n\t<\/tbody>\n<\/table>\n\n\n\t\n\t\t\n\t\t\t
Schema Downloader: The schema downloader provides a standalone tool to download service schemas, which can then be used with the TestUtil component to create messages to test your application behavior.<\/td>\n\t\t<\/tr>\n\t<\/tbody>\n<\/table>\n\n\n\t\n\t\t\n\t\t\t
API Python<\/td>\n\t\t<\/tr>\n\t<\/tbody>\n<\/table>\n\n\t

The Python API can be installed through ‘pip’ using:<\/p>\n

>> python -m pip install --index-url=https:\/\/blpapi.bloomberg.com\/repository\/releases\/python\/simple\/ blpapi<\/pre>\n
We\u00a0support<\/strong> and provide wheels for Python 3.8, 3.9, 3.10, 3.11, and 3.12; Both 32 and 64 bits, for Windows, macOS, and most versions of Linux. These wheels now come bundled with the required C++ API, and a separate C++ API installation is no longer required.<\/div>\n
 <\/p>\n
On Linux, ‘pip’ >= 19.3 is required to install these wheels. A source package is also provided for other platforms\/Python versions. If building the module from sources, a local installation of the C++ API is required for both building and importing the blpapi module in Python.<\/div>\n
 <\/p>\n
\n
Note: The oldest supported version of Python for BLPAPI is currently Python 3.8.<\/p>\n<\/div>\n\n<\/div>\n\n\n\t\n\t\t\n\t\t\t
BLPAPI via FFI: These libraries use a Foreign Function Interface (FFI) to combine a native C++ backend with language-specific interfaces, providing improved performance, cross-language consistency, and minimal client-side changes. Currently, only C# FFI is supported.<\/td>\n\t\t<\/tr>\n\t<\/tbody>\n<\/table>\n\n\t
The C# (.NET) FFI API can be installed through the .NET CLI<\/p>\n
One-time: add Bloomberg\u2019s private NuGet feed
\n>> dotnet nuget add source --name bloomberg-blpapi-release --username token --password download --store-password-in-clear-text https:\/\/token:download@nuget.blpapi.bloomberg.com\/releases\/v3\/index.json<\/code><\/p>\n
Install the latest C# (.NET) FFI experimental release
\n>> dotnet add package Bloomberg.Blpapi --prerelease<\/code><\/p>\n
Revert to the latest non-FFI C#(.NET) package
\n>> dotnet add package Bloomberg.Blpapi<\/code>
\nTo pin a specific version, use --version<\/code> .<\/p>\n
C# (.NET) FFI documentation<\/a><\/p>\n\n<\/div>\n\n<\/div>\n\n\n                    <\/div>\n    <\/section>\n<\/div>\n\n
\n    
\n        \n        \n        \n            \n            \n    
\n\n\n<\/div>\n\n\n                    <\/div>\n    <\/section>\n<\/div>\n","protected":false},"excerpt":{"rendered":"
Support API Library API Library Notes Supported Releases: These releases have been certified by Bloomberg\u2019s Enterprise Products team for use by Bloomberg customers. Experimental Releases: These releases have not yet been certified for use by Bloomberg customers, but have been released by the API library engineering team in order to address specific issues or add…<\/p>\n","protected":false},"author":1857,"featured_media":0,"parent":8091,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_yoast_wpseo_primary_category":"","footnotes":""},"class_list":["post-7927","page","type-page","status-publish","hentry"],"yoast_head":"\nAPI Library | Bloomberg Professional Services<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/professional.content.cirrus.bloomberg.com\/professional2023\/support\/api-library\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"API Library | Bloomberg Professional Services\" \/>\n<meta property=\"og:url\" content=\"https:\/\/professional.content.cirrus.bloomberg.com\/professional2023\/support\/api-library\/\" \/>\n<meta property=\"og:site_name\" content=\"Bloomberg Professional Services\" \/>\n<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/bloomberglp\" \/>\n<meta property=\"article:modified_time\" content=\"2026-01-12T19:59:09+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/assets.bbhub.io\/image\/v1\/resize?width=auto&type=webp&url=https:\/\/assets.bbhub.io\/professional\/sites\/41\/BPS-og-image.png\" \/>\n\t<meta property=\"og:image:width\" content=\"1200\" \/>\n\t<meta property=\"og:image:height\" content=\"630\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/png\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:site\" content=\"@theterminal\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"3 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/professional.content.cirrus.bloomberg.com\/professional2023\/support\/api-library\/\",\"url\":\"https:\/\/professional.content.cirrus.bloomberg.com\/professional2023\/support\/api-library\/\",\"name\":\"API Library | Bloomberg Professional Services\",\"isPartOf\":{\"@id\":\"https:\/\/professional.content.cirrus.bloomberg.com\/professional2023\/#website\"},\"datePublished\":\"2024-03-01T22:40:11+00:00\",\"dateModified\":\"2026-01-12T19:59:09+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/professional.content.cirrus.bloomberg.com\/professional2023\/support\/api-library\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/professional.content.cirrus.bloomberg.com\/professional2023\/support\/api-library\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/professional.content.cirrus.bloomberg.com\/professional2023\/support\/api-library\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":\"1\",\"name\":\"Support\",\"item\":\"https:\/\/professional.content.cirrus.bloomberg.com\/professional2023\/support\/\"},{\"@type\":\"ListItem\",\"position\":\"2\",\"name\":\"API Library\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/professional.content.cirrus.bloomberg.com\/professional2023\/#website\",\"url\":\"https:\/\/professional.content.cirrus.bloomberg.com\/professional2023\/\",\"name\":\"Bloomberg Professional Services\",\"description\":\"\",\"publisher\":{\"@id\":\"https:\/\/professional.content.cirrus.bloomberg.com\/professional2023\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/professional.content.cirrus.bloomberg.com\/professional2023\/?s={search_term_string}\"},\"query-input\":\"required name=search_term_string\"}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/professional.content.cirrus.bloomberg.com\/professional2023\/#organization\",\"name\":\"Bloomberg Professional Services\",\"url\":\"https:\/\/professional.content.cirrus.bloomberg.com\/professional2023\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/professional.content.cirrus.bloomberg.com\/professional2023\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/assets.bbhub.io\/image\/v1\/convert?type=auto&url=https%3A%2F%2Fassets.bbhub.io%2Fprofessional%2Fsites%2F41%2Flogo.png\",\"contentUrl\":\"https:\/\/assets.bbhub.io\/image\/v1\/convert?type=auto&url=https%3A%2F%2Fassets.bbhub.io%2Fprofessional%2Fsites%2F41%2Flogo.png\",\"width\":\"512\",\"height\":\"103\",\"caption\":\"Bloomberg Professional Services\"},\"image\":{\"@id\":\"https:\/\/professional.content.cirrus.bloomberg.com\/professional2023\/#\/schema\/logo\/image\/\"},\"sameAs\":[\"https:\/\/www.instagram.com\/bloomberg\/\",\"https:\/\/www.linkedin.com\/showcase\/bloomberg-professional-service\/\",\"https:\/\/www.facebook.com\/bloomberglp\",\"https:\/\/twitter.com\/theterminal\"]}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"API Library | Bloomberg Professional Services","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/professional.content.cirrus.bloomberg.com\/professional2023\/support\/api-library\/","og_locale":"en_US","og_type":"article","og_title":"API Library | Bloomberg Professional Services","og_url":"https:\/\/professional.content.cirrus.bloomberg.com\/professional2023\/support\/api-library\/","og_site_name":"Bloomberg Professional Services","article_publisher":"https:\/\/www.facebook.com\/bloomberglp","article_modified_time":"2026-01-12T19:59:09+00:00","og_image":[{"width":1200,"height":630,"url":"https:\/\/assets.bbhub.io\/image\/v1\/resize?width=auto&type=webp&url=https:\/\/assets.bbhub.io\/professional\/sites\/41\/BPS-og-image.png","type":"image\/png"}],"twitter_card":"summary_large_image","twitter_site":"@theterminal","twitter_misc":{"Est. reading time":"3 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/professional.content.cirrus.bloomberg.com\/professional2023\/support\/api-library\/","url":"https:\/\/professional.content.cirrus.bloomberg.com\/professional2023\/support\/api-library\/","name":"API Library | Bloomberg Professional Services","isPartOf":{"@id":"https:\/\/professional.content.cirrus.bloomberg.com\/professional2023\/#website"},"datePublished":"2024-03-01T22:40:11+00:00","dateModified":"2026-01-12T19:59:09+00:00","breadcrumb":{"@id":"https:\/\/professional.content.cirrus.bloomberg.com\/professional2023\/support\/api-library\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/professional.content.cirrus.bloomberg.com\/professional2023\/support\/api-library\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/professional.content.cirrus.bloomberg.com\/professional2023\/support\/api-library\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":"1","name":"Support","item":"https:\/\/professional.content.cirrus.bloomberg.com\/professional2023\/support\/"},{"@type":"ListItem","position":"2","name":"API Library"}]},{"@type":"WebSite","@id":"https:\/\/professional.content.cirrus.bloomberg.com\/professional2023\/#website","url":"https:\/\/professional.content.cirrus.bloomberg.com\/professional2023\/","name":"Bloomberg Professional Services","description":"","publisher":{"@id":"https:\/\/professional.content.cirrus.bloomberg.com\/professional2023\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/professional.content.cirrus.bloomberg.com\/professional2023\/?s={search_term_string}"},"query-input":"required name=search_term_string"}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/professional.content.cirrus.bloomberg.com\/professional2023\/#organization","name":"Bloomberg Professional Services","url":"https:\/\/professional.content.cirrus.bloomberg.com\/professional2023\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/professional.content.cirrus.bloomberg.com\/professional2023\/#\/schema\/logo\/image\/","url":"https:\/\/assets.bbhub.io\/image\/v1\/convert?type=auto&url=https%3A%2F%2Fassets.bbhub.io%2Fprofessional%2Fsites%2F41%2Flogo.png","contentUrl":"https:\/\/assets.bbhub.io\/image\/v1\/convert?type=auto&url=https%3A%2F%2Fassets.bbhub.io%2Fprofessional%2Fsites%2F41%2Flogo.png","width":"512","height":"103","caption":"Bloomberg Professional Services"},"image":{"@id":"https:\/\/professional.content.cirrus.bloomberg.com\/professional2023\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.instagram.com\/bloomberg\/","https:\/\/www.linkedin.com\/showcase\/bloomberg-professional-service\/","https:\/\/www.facebook.com\/bloomberglp","https:\/\/twitter.com\/theterminal"]}]}},"_links":{"self":[{"href":"https:\/\/professional.content.cirrus.bloomberg.com\/professional2023\/wp-json\/wp\/v2\/pages\/7927","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/professional.content.cirrus.bloomberg.com\/professional2023\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/professional.content.cirrus.bloomberg.com\/professional2023\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/professional.content.cirrus.bloomberg.com\/professional2023\/wp-json\/wp\/v2\/users\/1857"}],"replies":[{"embeddable":true,"href":"https:\/\/professional.content.cirrus.bloomberg.com\/professional2023\/wp-json\/wp\/v2\/comments?post=7927"}],"version-history":[{"count":13,"href":"https:\/\/professional.content.cirrus.bloomberg.com\/professional2023\/wp-json\/wp\/v2\/pages\/7927\/revisions"}],"predecessor-version":[{"id":138265,"href":"https:\/\/professional.content.cirrus.bloomberg.com\/professional2023\/wp-json\/wp\/v2\/pages\/7927\/revisions\/138265"}],"up":[{"embeddable":true,"href":"https:\/\/professional.content.cirrus.bloomberg.com\/professional2023\/wp-json\/wp\/v2\/pages\/8091"}],"wp:attachment":[{"href":"https:\/\/professional.content.cirrus.bloomberg.com\/professional2023\/wp-json\/wp\/v2\/media?parent=7927"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}