@binance/broker-portal-sdk

@binance/broker-portal-sdk

• You are not on any trade or economic sanctions lists, such as the UN Security Council Sanctions list, designated as a “Specially Designated National” by OFAC (Office of Foreign Assets Control of the U.S. Treasury Department) or placed on the U.S. Commerce Department’s “Denied Persons List”.

• You are not providing any restricted/prohibited business that could constitute illegal, unlawful activities.

How to start

If you are interested in the Portal Tool, please fill the application form or contact [e-mail]. Binance team members will reach out via Telegram or Email to help you with onboarding.

Start in 5 minutes

If you have got your broker_id, please add the codes below and input your

HTML

<script src="https://public.bnbstatic.com/static/js/broker-sdk/[e-mail]"></script>
<div id="widget"></div>

<script>
    window.onload = function () {
        window.binanceBrokerPortalSdk.initBrokerSDK('#widget', {
            apiHost: 'https://www.binance.com',
            brokerId: 'your-broker-id'
        })
    }
</script>

finally, check the Jump link has the params ref, like this: https://www.binance.com/en?source=broker-sdk&ref=xxx

React usage

import { initBrokerSDK } from '@binance/broker-portal-sdk'
const app = () => {
    React.useEffect(() => {
        initBrokerSDK('#test', {
            apiHost: 'https://www.binance.com',
            brokerId: 'your-broker-id'
        })
    }, [])
    return <div id="test"></div>
}

Parameters

initBrokerSDK(el, {
    apiHost,
    brokerId,
    site,
    overrideStyle,
    slideTime,
    target,
})

• el: string | string[] required

  DOM selector

• options.apiHost: string required

  API host, you can use https://www.binance.com by default

• options.brokerId: string required

  Your broker id

• options.site: "global" | "site" optional

  Site of jump links, default set to global

• options.overrideStyle: string optional

  Customize style by pure CSS code, eg:

  .bnc-broker-widget-footer{height: 20px;} /* change style of widget footer */
  

• options.slideTime: number optional

  Delay between slide transitions(in ms), default set to 5000

• options.target: "_self" | "_blank" | "_parent" | "top" optional

  target attribute of link, default set to "_self"