Platform Manager v1.1 Documentation

Icon API

Once you have registered your Platform in BrickFunding with the Freemium Plan, you will be able to connect your crowdfunding site with our API for free and publish your investment opportunities on our site.

To do this, simply inject the information about your projects, following the instructions below, and start receiving investors at no cost. Review all the data to ensure maximum accuracy and get our investors to choose you to invest. And, if you wish, you can also inject the information from your blog and each time you publish a new article we will communicate it to our users. Get quality leads for your website for free by connecting to our API!

If you don't have a technical team and you need us to develop your own API, or you need help to implement the integration contact us and we will give you a quote. Connect with our API or give us access to yours and we will take care of the integration.

Benefits of using our API

  • You will be able to publish your projects: to guarantee the quality of the data we show, we do not accept the manual publication of projects, we only publish the projects that are injected in an automated way through our API. And our investors value much more the platforms that show the information of their projects. So, although with your Freemium Plan you can only have your Platform Card and use our API, we strongly recommend that you inject your information and publish your projects in brickFunding!
  • You will get more traffic: the traffic we refer to you increases by up to 300%. The platforms that list their projects and articles with us via API receive up to three times more visits than those that only list their platform file.
  • You will be better positioned in our listings: the traffic we refer to you increases by up to 300%. The platforms that list their projects and articles with us via API receive up to three times more visits than those that only list their platform file.
  • You will be able to publish your articles: every time you publish a new article in your blog, you can also inject us with the basic information about it and a link to it will appear in your Platform File and in our news section. Interested investors will be redirected to your website for reading.
  • You will appear in our Newsletter: weekly we send our users a newsletter with the latest investment projects and articles that have been injected into our API. Access thousands of potential investors easily.
  • It's free: this is the best of all, if you register your platform with us and integrate your information through our API you can get all this for free!
Imagen de BrickFunding

If need further assistance please contact us platforms@brickfunding.com

Platform Information

GET PLATFORM





METHOD: GET

ENDPOINT: https://brickapi.brickfunding.com/platforms/platform?apikey=Your_api_key

RESPONSE TYPE: JSON

RESPONSE:

PropertyValuesDescription
oktrue/falseTrue if request succeeded or false if there were errors
messageVariesA textual message of what the response is about
data

Object containing the following properties:

idInternal ID
nameName
addressAddress
poboxZIP Code
cityCity
stateState
countryCountry (ISO Alpha-2)
emailEmail
phonePhone
foundationYear of foundation (4 digits)
facebookFacebook URL
twitterTwitter URL
linkedinLinkedIn URL
languageMain Language (ISO 639-1)
currencyMain Currency (ISO 4217)
createdCreation date (EPOCH milliseconds)
updatedUpdated date (EPOCH milliseconds)
languages

Object containing:

language (ISO 639-1)

One Object per language containing:

urlPlatforms URL
introPlatform's introduction (optional)
descriptionPlatform's description
payment

Object containing:

planSelected payment plan
currencyFee currency
feeCurrent fee
details

Object containing invoice details

addressAddress
poboxZIP Code
cityCity
stateState
countryCountry (ISO Alpha-2)
Platform's information


UPDATE PLATFORM

METHOD: POST

ENDPOINT: https://brickapi.brickfunding.com/platforms/platform?apikey=Your_api_key

REQUEST BODY: JSON

REQUEST PARAMS:

PropertyValueDescription
address (optional)StringAddress
pobox (optional)StringZIP Code
city (optional)StringCity
state (optional)StringState
country (optional)String (ISO Alpha-2 Code)Country
email (optional)String (Email)Email
phone (optional)StringPhone
foundation (optional)Integer (4 digits)Year of foundation
facebook (optional)String (URL)Facebook URL
twitter (optional)String (URL)Twitter URL
linkedin (optional)String (URL)LinkedIn URL
language (optional)String (ISO 639-1 Code)Main Language
currency (optional)String (ISO 4217 Code)Main Currency
languages (optional)

One Object per language (ISO 639-1 Code as Key) containing:

urlString (URL)Platforms URL
introString (optional)Platform's introduction (optional)
descriptionStringPlatform's description

Object containing data based on languages.

Example:

                        languages: {
                          en: {
                            url: "http://www.myplatform.com/en",
                            intro: "My intro",
                            description: "My long description"
                          },
                          es: {
                            url: "http://www.myplatform.com/es",
                            intro: "Una introducción",
                            description: "Una descripción larga"
                          }
                        }
                      

RESPONSE TYPE: JSON

RESPONSE:

PropertyValuesDescription
oktrue/falseTrue if request succeeded or false if there were errors
messageVariesA textual message of what the response is about
(optional) errorsArray of stringsList of errors detected


Projects Information



GET ALL PROJECTS

METHOD: GET

ENDPOINT: https://brickapi.brickfunding.com/platforms/projects?apikey=Your_api_key

RESPONSE TYPE: JSON

RESPONSE:

PropertyValuesDescription
oktrue/falseTrue if request succeeded or false if there were errors
messageVariesA textual message of what the response is about
data (Array)

Array containing objects with the following properties:

idInternal ID
_scrapper_original_idYOUR Unique ID
nameName
addressAddress
poboxZIP Code
cityCity
stateState
countryCountry (ISO Alpha-2)
languageMain Language (ISO 639-1)
currencyMain Currency (ISO 4217)
statusProject's Status (open/close)
active1/0 (number) Published on website
completedCompleted percentage (0-100)
minimumMinimum investment amount
targetTarget amount
iniStarting Date (EPOCH milliseconds)
endEnding Date (EPOCH milliseconds)
finishedFunding finish date (EPOCH milliseconds)
investorsNumber of investors
grossGross Rate Percentage
netNet Rate Percentage
cocCash-On-Cash Rate Percentage
disinvestmentPeriod in months of disinvestment
createdCreation date (EPOCH milliseconds)
updatedUpdated date (EPOCH milliseconds)
imageInternal ID for Main Image
imagesArray of extra images (URLs)
languages

Object containing:

KeyValue
language (ISO 639-1)

One Object per language containing:

url (required)String (URL)Project's URL
intro (optional)StringProject's introduction (optional)
description (required)StringProject's description
Projects's information


CREATE/UPDATE PROJECTS

METHOD: POST

ENDPOINT: https://brickapi.brickfunding.com/platforms/projects?apikey=Your_api_key

REQUEST TYPE: JSON

REQUEST:

PropertyValueDescription
projects

Array of Objects

PropertyValueDescription
id (required)StringYOUR Internal Project's ID
name (optional)StringName (required if new)
address (optional)StringAddress (required if new)
pobox (optional)StringZIP Code (required if new)
city (optional)StringCity (required if new)
state (optional)StringState (required if new)
country (optional)String (ISO Alpha-2)Country (required if new)
language (optional)String (ISO 639-1)Main Language (required if new)
currency (optional)String (ISO 4217)Main Currency (required if new)
status (optional)String (open/close)Project's Status (required if new)
active (optional)Integer (1/0)Published on BF website (Yes=1 or No=0)
completed (optional)IntegerCompleted percentage (0-100) (required if new)
minimum (optional)FloatMinimum investment amount (required if new)
target (optional)FloatTarget amount (required if new)
ini (optional)Format: Integer EPOCH (milliseconds) or YYYY-MM-DDStarting Date (required if new)
end (optional)Format: Integer EPOCH (milliseconds) or YYYY-MM-DDEnding Date(blank for no ending)
finished (optional)Format: Integer EPOCH (milliseconds) or YYYY-MM-DDProject's Finished Funded Date (if status closed)
investors (optional)IntegerNumber of investors (required if new)
gross (optional)FloatGross Rate Percentage (required if new)
net (optional)FloatNet Rate Percentage (required if new)
coc (optional)FloatCash-On-Cash Rate Percentage (required if new)
disinvestment (optional)IntegerPeriod in months of disinvestment (required if new)
images (optional)Array (URLs)List of images URLs.
Note: First one will be the Main Image.
(required if new)
languages (optional)

One Object per language (ISO 639-1 Code as Key) containing:

KeyValue
language (ISO 639-1)

One Object per language containing:

url (required)String (URL)Project's URL
intro (optional)StringProject's introduction (optional)
description (required)StringProject's description

(required if new)

Languages object with per language information.

Example:

                              languages: {
                                en: {
                                  url: "http://www.myplatform.com/en/myproject",
                                  intro: "My intro",
                                  description: "My long description"
                                },
                                es: {
                                  url: "http://www.myplatform.com/es/miproyecto",
                                  intro: "Una introducción",
                                  description: "Una descripción larga"
                                }
                              }
                            
Array of objects containing project's information

RESPONSE TYPE: JSON

RESPONSE:

PropertyValuesDescription
oktrue/falseTrue if request succeeded or false if there were errors
messageVariesA textual message of what the response is about
(optional) errorsArray of stringsList of errors detected


GET PROJECT

METHOD: GET

ENDPOINT: https://brickapi.brickfunding.com/platforms/projects/{PROJECTID}?apikey=Your_api_key

RESPONSE TYPE: JSON

RESPONSE:

PropertyValuesDescription
oktrue/falseTrue if request succeeded or false if there were errors
messageVariesA textual message of what the response is about
data

Object containing the following properties:

idInternal ID
_scrapper_original_idYOUR Unique ID
nameName
addressAddress
poboxZIP Code
cityCity
stateState
countryCountry (ISO Alpha-2)
languageMain Language (ISO 639-1)
currencyMain Currency (ISO 4217)
statusProject's Status (open/close)
active1/0 (number) Published on website
completedCompleted percentage (0-100)
minimumMinimum investment amount
targetTarget amount
iniStarting Date (EPOCH milliseconds)
endEnding Date (EPOCH milliseconds)
finishedFunding finish date (EPOCH milliseconds)
investorsNumber of investors
grossGross Rate Percentage
netNet Rate Percentage
cocCash-On-Cash Rate Percentage
disinvestmentPeriod in months of disinvestment
createdCreation date (EPOCH milliseconds)
updatedUpdated date (EPOCH milliseconds)
imageInternal ID for Main Image
imagesArray (URLs) of extra images
languages

Object containing:

KeyValue
language (ISO 639-1)

One Object per language containing:

urlProject's URL
introProject's introduction (optional)
descriptionProject's description
Projects's information


UPDATE PROJECT

METHOD: POST

ENDPOINT: https://brickapi.brickfunding.com/platforms/projects/{PROJECTID}?apikey=Your_api_key

REQUEST TYPE: JSON

REQUEST:

PropertyValueDescription
id (required)StringYOUR Internal Project's ID
name (optional)StringName
address (optional)StringAddress
pobox (optional)StringZIP Code
city (optional)StringCity
state (optional)StringState
country (optional)String (ISO Alpha-2)Country
language (optional)String (ISO 639-1)Main Language
currency (optional)String (ISO 4217)Main Currency
status (optional)String (open/close)Project's Status
active (optional)Integer (1/0)Published on BF website (Yes=1 or No=0)
completed (optional)IntegerCompleted percentage (0-100)
minimum (optional)FloatMinimum investment amount
target (optional)FloatTarget amount
ini (optional)Format: Integer EPOCH (milliseconds) or YYYY-MM-DDStarting Date
end (optional)Format: Integer EPOCH (milliseconds) or YYYY-MM-DDEnding Date
finished (optional)Format: Integer EPOCH (milliseconds) or YYYY-MM-DDProject's Finished Funded Date
investors (optional)IntegerNumber of investors
gross (optional)FloatGross Rate Percentage
net (optional)FloatNet Rate Percentage
coc (optional)FloatCash-On-Cash Rate Percentage
disinvestment (optional)IntegerPeriod in months of disinvestment
images (optional)Array (URLs)List of images URLs.
Note: First one will be the Main Image
languages (optional)

One Object per language (ISO 639-1 Code as Key) containing:

KeyValue
language (ISO 639-1)

One Object per language containing:

url (required)String (URL)Project's URL
intro (optional)StringProject's introduction (optional)
description (required)StringProject's description

Languages object with per language information.

Example:

                        languages: {
                          en: {
                            url: "http://www.myplatform.com/en/myproject",
                            intro: "My intro",
                            description: "My long description"
                          },
                          es: {
                            url: "http://www.myplatform.com/es/miproyecto",
                            intro: "Una introducción",
                            description: "Una descripción larga"
                          }
                        }
                      

RESPONSE TYPE: JSON

RESPONSE:

PropertyValuesDescription
oktrue/falseTrue if request succeeded or false if there were errors
messageVariesA textual message of what the response is about
(optional) errorsArray of stringsList of errors detected


Posts Information



INSERT POSTS

METHOD: POST

ENDPOINT: https://brickapi.brickfunding.com/platforms/posts?apikey=Your_api_key

REQUEST TYPE: JSON

REQUEST:

PropertyValuesDescription
name (required)String (plain text)The name/title of the post
description (required)String (plain text)A short abstract of the article
body (required)String (html)The body of the post
language (required)StringLanguage of the post (ISO 639-1)
date (required)NumberPublished Date (EPOCH milliseconds)
image (required)URL (string)Absolute URL Image
source (optional)URL (string)Absolute URL of the post on your site