Vestorly API API

by vestorly.com

Overview

Vestorly Developers API

Vestorly API is a business API from vestorly.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 51 endpoints.

At a glance

Authentication: OAuth
HTTPS: Yes
CORS: Unknown
Category: Business
Base URL: https://staging.vestorly.com/api/v2
Version: 1.0.0
Endpoints: 51
OpenAPI: Specification ↗
Spec updated: 2020-11-23

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL

curl -X GET "https://staging.vestorly.com/api/v2/article_phrases" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"

JavaScript

const response = await fetch("https://staging.vestorly.com/api/v2/article_phrases", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
  },
});
const data = await response.json();
console.log(data);

Python

import requests

response = requests.request(
    "GET",
    "https://staging.vestorly.com/api/v2/article_phrases",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

Method	Path	What it does
GET	`/advisors/{id}`	Returns a single advisor given their ID
GET	`/article_phrases`	Returns phrases used in Categories
GET	`/articles`	Returns all articles
GET	`/articles/{id}`	Returns a single article
GET	`/custom_feed_filters`	Returns all Categorie's filters
POST	`/custom_feed_filters`	Creates a new Category filter
GET	`/custom_feed_filters/{id}`	Returns a single Category's filter
PUT	`/custom_feed_filters/{id}`	Updates a Category Feed Filter
DELETE	`/custom_feed_filters/{id}`	Deletes the Category's filter
GET	`/custom_feeds`	Returns all Categories
POST	`/custom_feeds`	Creates a new Category
GET	`/custom_feeds/{id}`	Returns a single Category
PUT	`/custom_feeds/{id}`	Updates a Category
DELETE	`/custom_feeds/{id}`	Deletes a new Category
GET	`/custom_feeds/{id}/articles`	Returns Articles by Category
POST	`/custom_feeds/{id}/duplicates`	Duplicates Category
GET	`/events`	Returns all events
POST	`/events`	Creates a new event in the system
GET	`/events/{id}`	Returns a single event if the user has access
GET	`/groups`	Returns all groups
POST	`/groups`	Creates a new Group
GET	`/groups/{id}`	Returns a single group if user has access
PUT	`/groups/{id}`	Updates a Group
DELETE	`/groups/{id}`	Deletes a Group
GET	`/member_events`	Returns all MemberEvents
GET	`/member_reports`	Returns all member reports
GET	`/members`	Returns all members
POST	`/members`	Create a new member in the Vestorly Platform
GET	`/members/{id}`	Returns a single member
PUT	`/members/{id}`	Updates a single member
GET	`/newsletter_settings`	Returns all newsletter settings
GET	`/newsletter_settings/{id}`	Returns a single newsletter settings if the user has access
PUT	`/newsletter_settings/{id}`	Update a single newsletter setting by ID
GET	`/newsletters`	Returns all newsletters
GET	`/newsletters/{id}`	Get a newsletter by ID
PUT	`/newsletters/{id}`	Updates a newsletter
GET	`/posts`	Query all posts
POST	`/posts`	Create a new post in the Vestorly Platform
GET	`/posts/{id}`	Query all posts
PUT	`/posts/{id}`	Update A Post
GET	`/seed_custom_feeds`	Returns all Categories keywords
POST	`/seed_custom_feeds`	Creates a new Category Keyword
GET	`/seed_custom_feeds/{id}`	Returns a single Category keyword
PUT	`/seed_custom_feeds/{id}`	Updates a Category keywords
DELETE	`/seed_custom_feeds/{id}`	Deletes a Category keywords
POST	`/sessions`	Login To Vestorly Platform
DELETE	`/sessions/{id}`	Logout of the vestorly platform
GET	`/sources`	Returns all sources
POST	`/sources`	Create source
GET	`/sources/{id}`	Get Source By ID
PUT	`/sources/{id}`	Update Source By ID