Vestorly

Vestorly API

Vestorly Developers API

Other#openapi#marketing

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Vestorly Developers API

Endpoints 51

advisors

  • GETfindAdvisorByID/advisors/:id?vestorly_auth=string&access_token=stringReturns a single advisor given their ID

article_phrase

  • GETfindArticlePhrases/article_phrases?vestorly_auth=string&access_token=string&text_search=string&size=0&from=0Returns phrases used in Categories

articles

  • GETfindArticles/articles?vestorly_auth=string&access_token=string&limit=0&text_query=string&sort_direction=string&sort_by=stringReturns all articles
  • GETfindArticleByID/articles/:id?vestorly_auth=string&access_token=stringReturns a single article

custom_feed_filters

  • GETfindCustomFeedFilters/custom_feed_filters?vestorly_auth=string&access_token=stringReturns all Categorie's filters
  • POSTcreateCustomFeedFilter/custom_feed_filters?vestorly_auth=string&access_token=stringCreates a new Category filter
  • GETfindCustomFeedFilterByID/custom_feed_filters/:id?vestorly_auth=string&access_token=stringReturns a single Category's filter
  • PUTupdateCustomFeedFilterById/custom_feed_filters/:id?vestorly_auth=string&access_token=stringUpdates a Category Feed Filter
  • DELETEdeleteCustomFeedFilter/custom_feed_filters/:id?vestorly_auth=string&access_token=stringDeletes the Category's filter

custom_feeds

  • GETfindCustomFeeds/custom_feeds?vestorly_auth=string&access_token=stringReturns all Categories
  • POSTcreateCustomFeed/custom_feeds?vestorly_auth=string&access_token=stringCreates a new Category
  • GETfindCustomFeedByID/custom_feeds/:id?vestorly_auth=string&access_token=stringReturns a single Category
  • PUTupdateCategoryById/custom_feeds/:id?vestorly_auth=string&access_token=stringUpdates a Category
  • DELETEdeleteCustomFeed/custom_feeds/:id?vestorly_auth=string&access_token=stringDeletes a new Category
  • POSTduplicateCustomFeed/custom_feeds/:id/duplicates?vestorly_auth=string&access_token=stringDuplicates Category

custom_feed_articles

  • GETfindCustomFeedArticles/custom_feeds/:id/articles?vestorly_auth=string&access_token=string&limit=0&sort_by=string&start=0&created_at_gte_days_ago=string&text_query=stringReturns Articles by Category

events

  • GETfindEvents/events?vestorly_auth=string&access_token=stringReturns all events
  • POSTcreateEvent/events?vestorly_auth=string&access_token=stringCreates a new event in the system
  • GETfindEventByID/events/:id?access_token=string&vestorly_auth=stringReturns a single event if the user has access

groups

  • GETfindGroups/groups?vestorly_auth=string&access_token=stringReturns all groups
  • POSTcreateGroup/groups?vestorly_auth=string&access_token=stringCreates a new Group
  • GETfindGroupByID/groups/:id?vestorly_auth=string&access_token=stringReturns a single group if user has access
  • PUTupdateGroupById/groups/:id?vestorly_auth=string&access_token=stringUpdates a Group
  • DELETEdeleteGroup/groups/:id?vestorly_auth=string&access_token=stringDeletes a Group

member_events

  • GETfindMemberEvents/member_events?vestorly_auth=string&access_token=stringReturns all MemberEvents

member_reports

  • GETfindMemberReports/member_reports?vestorly_auth=string&access_token=stringReturns all member reports

members

  • GETfindMembers/members?vestorly_auth=string&access_token=string&start=0&limit=0Returns all members
  • POSTcreateMember/members?vestorly_auth=string&access_token=stringCreate a new member in the Vestorly Platform
  • GETfindMemberByID/members/:id?vestorly_auth=string&access_token=stringReturns a single member
  • PUTupdateMemberByID/members/:id?vestorly_auth=string&access_token=stringUpdates a single member

newsletter_settings

  • GETfindNewsletterSettings/newsletter_settings?vestorly_auth=string&access_token=stringReturns all newsletter settings
  • GETfindNewsletterSettingsByID/newsletter_settings/:id?vestorly_auth=string&access_token=stringReturns a single newsletter settings if the user has access
  • PUTupdateNewsletterSettingsByID/newsletter_settings/:id?vestorly_auth=string&access_token=stringUpdate a single newsletter setting by ID

newsletters

  • GETfindNewsletters/newsletters?vestorly_auth=string&access_token=stringReturns all newsletters
  • GETgetNewsletterByID/newsletters/:id?vestorly_auth=string&access_token=stringGet a newsletter by ID
  • PUTupdateNewsletterByID/newsletters/:id?vestorly_auth=string&access_token=stringUpdates a newsletter

posts

  • GETfindPosts/posts?vestorly_auth=string&access_token=string&text_query=string&external_url=string&is_published=stringQuery all posts
  • POSTcreatePost/posts?vestorly_auth=string&access_token=stringCreate a new post in the Vestorly Platform
  • GETgetPostByID/posts/:id?vestorly_auth=string&access_token=stringQuery all posts
  • PUTupdatePostByID/posts/:id?vestorly_auth=string&access_token=stringUpdate A Post

seed_custom_feeds

  • GETfindSeedCustomFeeds/seed_custom_feeds?vestorly_auth=string&access_token=stringReturns all Categories keywords
  • POSTcreateSeedCustomFeed/seed_custom_feeds?vestorly_auth=string&access_token=stringCreates a new Category Keyword
  • GETfindSeedCustomFeedByID/seed_custom_feeds/:id?vestorly_auth=string&access_token=stringReturns a single Category keyword
  • PUTupdateSeedCustomFeedById/seed_custom_feeds/:id?vestorly_auth=string&access_token=stringUpdates a Category keywords
  • DELETEdeleteSeedCustomFeed/seed_custom_feeds/:id?vestorly_auth=string&access_token=stringDeletes a Category keywords

sessions

  • POSTlogin/sessions?username=string&password=stringLogin To Vestorly Platform
  • DELETElogout/sessions/:id?vestorly_auth=stringLogout of the vestorly platform

sources

  • GETfindSources/sources?vestorly_auth=string&access_token=stringReturns all sources
  • POSTcreateSource/sources?vestorly_auth=string&access_token=stringCreate source
  • GETgetSourceByID/sources/:id?vestorly_auth=string&access_token=stringGet Source By ID
  • PUTupdateSourceByID/sources/:id?vestorly_auth=string&access_token=stringUpdate Source By ID

API details

Base URL
https://staging.vestorly.com/api/v2
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
51 operations on 30 pathsGET 27POST 10PUT 9DELETE 5
Main resources
custom_feeds 6custom_feed_filters 5groups 5seed_custom_feeds 5members 4posts 4sources 4events 3newsletter_settings 3newsletters 3
Description format
Swagger 2.0, API version 1.0.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Vestorly API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Vestorly API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “findAdvisorByID” (GET /advisors/:id?vestorly_auth=string&access_token=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Vestorly API?

Vestorly Developers API It is listed under Other and has 51 endpoints.

Who publishes the Vestorly API?

It is listed from Vestorly's public API description (an OpenAPI document), not published by Vestorly on Swastik Codes. Anyone who controls vestorly.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Vestorly API?

Requests go to https://staging.vestorly.com/api/v2. Endpoint paths are added to this base URL.

How do I authenticate with the Vestorly API?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Vestorly API have?

51 operations on 30 paths (27 GET, 10 POST, 9 PUT, 5 DELETE). The largest groups are custom_feeds, custom_feed_filters, groups, seed_custom_feeds.

Is forking the Vestorly API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.