The BidPal endpoint enables 3rd party applications to configure the rebs BidPal settings.

Documentation

The BidPal endpoint enables 3th party applications to configure the rebs BidPal settings.

It is recomended that the authentication to this method is issued via access_token. Still you can [secretly] pass a user_key as a parameter and it will understand it just as good.

If you are using a framework that does not allow the Authorization to be in the header, you can still pass the access_token parameter as query string, the only requirement is that this has to be a POST request. Any other verb will result on loosing all the configurations.

Parameters

ParameterDefinition
apikeyAPI access key supplied by Rebuilding Society
userkeyToken for User Authentication see Userkey
max_bid_limitLimit in % of total user assets for single app bid
expiry_dateBidPal settings expiration date
risk_rate_a_plusRate for A+ risk apps
risk_rate_aRate for A risk apps
risk_rate_bRate for B risk apps
risk_rate_cRate for C risk apps
amount_a_plusMaximum amount of bids for A+ risk apps
amount_aMaximum amount of bids for A risk apps
amount_bMaximum amount of bids for B risk apps
amount_cMaximum amount of bids for C risk apps
active_a_plusEnable settings for A+ risk apps
active_aEnable settings for A risk apps
active_bEnable settings for B risk apps
active_cEnable settings for C risk apps
sectorSectors, that should be excluded
locationIncluded business locations
Language
Click Try It! to start a request and see the response here!