Fundz API Documentation

Fundz API Documentation

Feed Entry

Get feed_entries

Endpoint

GET /api/v3/companies

Parameters

Name Description
company Company Name
cities Collection cities in array []
selectItemstates Collection states in array []
zip_codes Collection zip code in array
selectItemindustries Industry
related_person Related Person
min_money_raised Money raised (range)
max_money_raised Money raised (range)
page Pagination
per_page Pagination

Request

Route

GET /api/v3/companies?company=Larkin+and+Sons&cities[]=Clarissaburgh&selectItemstates[]=Kansas&zip_codes[]&selectItemindustries=Gutmann%2C+Stehr+and+Trantow&related_person=Ardith+Shanahan+Jr.&min_money_raised=5&max_money_raised=10000000&page=1&per_page=10

Headers

Content-Type: application/json

Query Parameters

company=Larkin and Sons
cities=["Clarissaburgh"]
selectItemstates=["Kansas"]
zip_codes=[nil]
selectItemindustries=Gutmann, Stehr and Trantow
related_person=Ardith Shanahan Jr.
min_money_raised=5
max_money_raised=10000000
page=1
per_page=10

cURL

curl "https://app.fundz.net/api/v3/companies?company=Larkin+and+Sons&cities[]=Clarissaburgh&selectItemstates[]=Kansas&zip_codes[]&selectItemindustries=Gutmann%2C+Stehr+and+Trantow&related_person=Ardith+Shanahan+Jr.&min_money_raised=5&max_money_raised=10000000&page=1&per_page=10" -X GET \
	-H "Auth-Token: access token" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "feed_entries": [
    {
      "id": 466,
      "name": "Larkin and Sons",
      "web": "http://Larkin and Sons.com/marlon",
      "accepted_at": "2017-08-19T11:08:12.703-04:00",
      "state": "Kansas",
      "industry": "Gutmann, Stehr and Trantow",
      "is_business_combination_transaction": false,
      "money_raised": 138594,
      "offered_for_sale": "10000",
      "min_investment": 100
    }
  ],
  "previous_page": null,
  "current_page": 1,
  "next_page": null
}

Get feed_entry

Endpoint

GET /api/v3/companies/:id

Parameters

Name Description
id required Feed entry id

Request

Route

GET /api/v3/companies/467

Headers

Content-Type: application/json

cURL

curl "https://app.fundz.net/api/v3/companies/467" -X GET \
	-H "Auth-Token: access token" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": 467,
  "name": "Bayer, Grimes and Hettinger",
  "accepted_at": "2017-08-19T11:08:12.703-04:00",
  "state": "Nevada",
  "is_business_combination_transaction": false,
  "offered_for_sale": "10000",
  "min_investment": 100,
  "industry": "Gutmann, Stehr and Trantow",
  "money_raised": 681773,
  "description": "Chuck Norris doesn't have disk latency because the hard drive knows to hurry the hell up.",
  "contacts": [
    {
      "web": "http://Bayer, Grimes and Hettinger.com/alene",
      "facebook": "http://facebook.com/terrell.olson",
      "twitter": "http://twitter.com/francisco",
      "linkedin": "http://linkedin.com/mustafa.raynor",
      "address": [
        "1653 Abdiel Common",
        "1161 Ebba Villages"
      ],
      "phone": [
        "(496) 107-4002",
        "1-149-547-1214"
      ],
      "fax": [
        "1-703-873-5235",
        "(960) 208-2820"
      ],
      "email": [
        "tobin_braun@mosciski.name",
        "conrad@medhurst.biz"
      ]
    }
  ],
  "related_persons": [
    {
      "name": "Rocio Metz",
      "relationship": "National Farming Facilitator"
    }
  ]
}