Skip to content
Branch: master
Find file History
Latest commit 0f54e53 Apr 9, 2019
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
.swagger-codegen Add SDKs Apr 9, 2019
docs Add SDKs Apr 9, 2019
lib Add SDKs Apr 9, 2019
spec Add SDKs Apr 9, 2019
.gitignore Add SDKs Apr 9, 2019
.rspec Add SDKs Apr 9, 2019
.rubocop.yml Add SDKs Apr 9, 2019
.swagger-codegen-ignore Add SDKs Apr 9, 2019
Gemfile Add SDKs Apr 9, 2019
README.md Add SDKs Apr 9, 2019
Rakefile Add SDKs Apr 9, 2019
atom_api.gemspec Add SDKs Apr 9, 2019
git_push.sh Add SDKs Apr 9, 2019

README.md

atom_api

AtomApi - the Ruby gem for the Hydrogen Atom API

The Hydrogen Atom API

Full documentation: Nucleus | Electron | Proton

This SDK is automatically generated by the Swagger Codegen project:

Installation

Recommended: Use rbenv or rvm to create a Ruby environment for installation and usage of the gem

Build a gem

To build the Ruby code into a gem:

gem build atom_api.gemspec

Then either install the gem locally:

gem install ./atom_api-1.0.0.gem

(for development, run gem install --dev ./atom_api-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'atom_api', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'atom_api', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Full usage documentation is available: Nucleus | Electron | Proton

Please follow the installation procedure and then run the following code:

# Load the gem
require 'atom_api'

# Setup authorization
AtomApi.configure do |config|
  # Configure OAuth2 access token for authorization: oauth
  # Method 1: Fetch and set access token with client_id and client_secret
  config.access_token = config.get_oauth_token('MYCLIENTID', 'MYCLIENTSECRET')
  # Method 2: Set access token using an existing token
  config.access_token = 'MYACCESSTOKEN'
end

api_instance = AtomApi::ElectronApi.new

campaign_id = 'campaign_id_example' # String | UUID of a marketing campaign


begin
  #Delete a marketing campaign
  api_instance.delete_campaign(campaign_id)
rescue AtomApi::ApiError => e
  puts "Exception when calling ElectronApi->delete_campaign: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.hydrogenplatform.com

Class Method HTTP request Description
AtomApi::ElectronApi delete_campaign DELETE /electron/v1/campaign/{campaign_id} Delete a marketing campaign
AtomApi::ElectronApi delete_campaign_data_record DELETE /electron/v1/campaign_data/{campaign_data_id} Delete a marketing campaign data record
AtomApi::ElectronApi delete_campaign_plan DELETE /electron/v1/campaign_plan/{campaign_plan_id} Delete a marketing campaign plan
AtomApi::ElectronApi delete_chat_log DELETE /electron/v1/chat/{chat_id} Delete a chat log
AtomApi::ElectronApi delete_client_campaign DELETE /electron/v1/client_campaign/{client_campaign_id} Remove a client from a campaign
AtomApi::ElectronApi delete_consultation DELETE /electron/v1/consultation/{consultation_id} Delete a consultation
AtomApi::ElectronApi delete_document DELETE /electron/v1/document/{document_id} Delete a document
AtomApi::ElectronApi delete_faq DELETE /electron/v1/faq/{faq_id} Delete a FAQ
AtomApi::ElectronApi delete_sales_inquiry DELETE /electron/v1/sales/{sales_id} Delete a sales inquiry
AtomApi::ElectronApi delete_support_ticket DELETE /electron/v1/support_ticket/{support_ticket_id} Delete a support ticket
AtomApi::ElectronApi delete_support_ticket_comment DELETE /electron/v1/support_ticket_comment/{support_ticket_comment_id} Delete a support ticket comment
AtomApi::ElectronApi get_campaign GET /electron/v1/campaign/{campaign_id} Retrieve a marketing campaign
AtomApi::ElectronApi get_campaign_data_record GET /electron/v1/campaign_data/{campaign_data_id} Retrieve a marketing campaign data record
AtomApi::ElectronApi get_campaign_data_records GET /electron/v1/campaign_data List all marketing campaign data records
AtomApi::ElectronApi get_campaign_plan GET /electron/v1/campaign_plan/{campaign_plan_id} Retrieve a marketing campaign plan
AtomApi::ElectronApi get_campaign_plans GET /electron/v1/campaign_plan List all marketing campaign plans
AtomApi::ElectronApi get_campaigns GET /electron/v1/campaign List all marketing campaigns
AtomApi::ElectronApi get_chat_log GET /electron/v1/chat/{chat_id} Retrieve a chat log
AtomApi::ElectronApi get_chat_logs GET /electron/v1/chat List all chat logs
AtomApi::ElectronApi get_client_campaign GET /electron/v1/client_campaign/{client_campaign_id} Retrieve a client assigned to a campaign
AtomApi::ElectronApi get_client_campaigns GET /electron/v1/client_campaign List information for all clients that are assigned to a marketing campaign defined for your firm
AtomApi::ElectronApi get_consultation GET /electron/v1/consultation/{consultation_id} Retrieve a consultation
AtomApi::ElectronApi get_consultations GET /electron/v1/consultation List all consultations
AtomApi::ElectronApi get_document GET /electron/v1/document/{document_id} Retrieve a document
AtomApi::ElectronApi get_documents GET /electron/v1/document List all documents
AtomApi::ElectronApi get_faq GET /electron/v1/faq/{faq_id} Retrieve a FAQ
AtomApi::ElectronApi get_faqs GET /electron/v1/faq List all FAQs
AtomApi::ElectronApi get_sales_inquiries GET /electron/v1/sales List all sales inquiries
AtomApi::ElectronApi get_sales_inquiry GET /electron/v1/sales/{sales_id} Retrieve a sales inquiry
AtomApi::ElectronApi get_support_ticket GET /electron/v1/support_ticket/{support_ticket_id} Retrieve a support ticket
AtomApi::ElectronApi get_support_ticket_comment GET /electron/v1/support_ticket_comment/{support_ticket_comment_id} Retrieve a support ticket comment
AtomApi::ElectronApi get_support_ticket_comments GET /electron/v1/support_ticket_comment List all support ticket comments
AtomApi::ElectronApi get_support_tickets GET /electron/v1/support_ticket List all support tickets
AtomApi::ElectronApi post_campaign POST /electron/v1/campaign Create a marketing campaign
AtomApi::ElectronApi post_campaign_data_record POST /electron/v1/campaign_data Create a marketing campaign data record
AtomApi::ElectronApi post_campaign_plan POST /electron/v1/campaign_plan Create a marketing campaign plan
AtomApi::ElectronApi post_chat_log POST /electron/v1/chat Create a chat log
AtomApi::ElectronApi post_client_campaign POST /electron/v1/client_campaign Assign a client to a campaign to indicate the client has registered through the campaign specified
AtomApi::ElectronApi post_consultation POST /electron/v1/consultation Create a consultation
AtomApi::ElectronApi post_document POST /electron/v1/document Create a document
AtomApi::ElectronApi post_faq POST /electron/v1/faq Create a faq
AtomApi::ElectronApi post_sales_inquiry POST /electron/v1/sales Create a sales inquiry
AtomApi::ElectronApi post_support_ticket POST /electron/v1/support_ticket Create a support ticket
AtomApi::ElectronApi post_support_ticket_comment POST /electron/v1/support_ticket_comment Create a support ticket comment
AtomApi::ElectronApi update_campaign PUT /electron/v1/campaign/{campaign_id} Update a marketing campaign
AtomApi::ElectronApi update_campaign_data_record PUT /electron/v1/campaign_data/{campaign_data_id} Update a marketing campaign data record
AtomApi::ElectronApi update_campaign_plan PUT /electron/v1/campaign_plan/{campaign_plan_id} Update a marketing campaign plan
AtomApi::ElectronApi update_chat_log PUT /electron/v1/chat/{chat_id} Update a chat log
AtomApi::ElectronApi update_client_campaign PUT /electron/v1/client_campaign/{client_campaign_id} Update a client assigned to a campaign
AtomApi::ElectronApi update_consultation PUT /electron/v1/consultation/{consultation_id} Update a consultation
AtomApi::ElectronApi update_document PUT /electron/v1/document/{document_id} Update a document
AtomApi::ElectronApi update_faq PUT /electron/v1/faq/{faq_id} Update a FAQ
AtomApi::ElectronApi update_sales_inquiry PUT /electron/v1/sales/{sales_id} Update a sales inquiry
AtomApi::ElectronApi update_support_ticket PUT /electron/v1/support_ticket/{support_ticket_id} Update a support ticket
AtomApi::ElectronApi update_support_ticket_comment PUT /electron/v1/support_ticket_comment/{support_ticket_comment_id} Update a support ticket comment
AtomApi::NucleusApi delete_account DELETE /nucleus/v1/account/{account_id}/ Delete an account
AtomApi::NucleusApi delete_account_allocation DELETE /nucleus/v1/account_allocation/{account_allocation_id} Delete an account allocation
AtomApi::NucleusApi delete_account_permission DELETE /nucleus/v1/account_permission/{account_id} Delete an account's permissions
AtomApi::NucleusApi delete_account_stage DELETE /nucleus/v1/stage/{stage_id} Delete an account stage
AtomApi::NucleusApi delete_account_status DELETE /nucleus/v1/account_status/{account_status_id} Delete an account status
AtomApi::NucleusApi delete_account_type DELETE /nucleus/v1/account_type/{account_type_id} Delete an account type
AtomApi::NucleusApi delete_aggregation_account DELETE /nucleus/v1/aggregation_account/{aggregation_account_id} Delete an aggregation account
AtomApi::NucleusApi delete_aggregation_account_balance DELETE /nucleus/v1/aggregation_account_balance/{aggregation_account_balance_id} Delete an aggregation account balance
AtomApi::NucleusApi delete_allocation DELETE /nucleus/v1/allocation/{allocation_id} Delete an allocation
AtomApi::NucleusApi delete_allocation_composition DELETE /nucleus/v1/allocation_composition/{allocation_composition_id} Delete an allocation composition
AtomApi::NucleusApi delete_bank_link DELETE /nucleus/v1/bank_link/{bank_link_id} Delete a bank link
AtomApi::NucleusApi delete_benchmark DELETE /nucleus/v1/benchmark/{benchmark_id} Delete a benchmark
AtomApi::NucleusApi delete_client DELETE /nucleus/v1/client/{client_id} Delete a client
AtomApi::NucleusApi delete_client_hydro DELETE /nucleus/v1/client_hydro/{client_hydro_id} Delete a client-hydro relationship
AtomApi::NucleusApi delete_client_response DELETE /nucleus/v1/client_response/{client_response_id} Delete a client response
AtomApi::NucleusApi delete_decision_tree DELETE /nucleus/v1/decision_tree/{decision_tree_id} Delete a decision tree
AtomApi::NucleusApi delete_deposit_request DELETE /nucleus/v1/deposit/{deposit_id} Delete a deposit request
AtomApi::NucleusApi delete_funding_request DELETE /nucleus/v1/funding/{funding_id} Delete a funding request
AtomApi::NucleusApi delete_goal DELETE /nucleus/v1/goal/{goal_id} Delete a goal
AtomApi::NucleusApi delete_goal_track_record DELETE /nucleus/v1/goal_track/{goal_track_id} Delete a goal track record
AtomApi::NucleusApi delete_model DELETE /nucleus/v1/model/{model_id} Delete a model
AtomApi::NucleusApi delete_model_asset_size DELETE /nucleus/v1/model_asset_size/{model_asset_size_id} Delete a model asset size
AtomApi::NucleusApi delete_model_comment DELETE /nucleus/v1/model_comment/{model_comment_id} Delete a model commentary
AtomApi::NucleusApi delete_model_holding DELETE /nucleus/v1/model_holding/{model_holding_id} Delete a model holding
AtomApi::NucleusApi delete_model_transaction DELETE /nucleus/v1/model_transaction/{model_transaction_id} Delete a model transaction
AtomApi::NucleusApi delete_node DELETE /nucleus/v1/node/{node_id} Delete a node
AtomApi::NucleusApi delete_node_relationship DELETE /nucleus/v1/node_relationship/{node_relationship_id} Delete a node relationship
AtomApi::NucleusApi delete_order_record DELETE /nucleus/v1/order/{order_id} Delete an order record
AtomApi::NucleusApi delete_order_status DELETE /nucleus/v1/order_status/{order_status_id} Delete an order status
AtomApi::NucleusApi delete_order_tracking_record DELETE /nucleus/v1/order_track/{order_track_id} Delete an order tracking record
AtomApi::NucleusApi delete_portfolio DELETE /nucleus/v1/portfolio/{portfolio_id} Delete a portfolio
AtomApi::NucleusApi delete_portfolio_asset_size DELETE /nucleus/v1/portfolio_asset_size/{portfolio_asset_size_id} Delete a portfolio asset size
AtomApi::NucleusApi delete_portfolio_comment DELETE /nucleus/v1/portfolio_comment/{portfolio_comment_id} Delete a portfolio commentary
AtomApi::NucleusApi delete_portfolio_holding DELETE /nucleus/v1/portfolio_holding/{portfolio_holding_id} Delete a portfolio holding
AtomApi::NucleusApi delete_portfolio_transaction DELETE /nucleus/v1/portfolio_transaction/{portfolio_transaction_id} Delete a portfolio transaction
AtomApi::NucleusApi delete_questionnaire DELETE /nucleus/v1/questionnaire/{questionnaire_id} Delete a questionnaire
AtomApi::NucleusApi delete_score DELETE /nucleus/v1/score/{score_id} Delete a score
AtomApi::NucleusApi delete_security DELETE /nucleus/v1/security/{security_id} Delete a security
AtomApi::NucleusApi delete_security_exclusion DELETE /nucleus/v1/security_exclusion/{security_exclusion_id} Delete a security exclusion
AtomApi::NucleusApi delete_security_price DELETE /nucleus/v1/security_price/{security_price_id} Delete a security price
AtomApi::NucleusApi delete_transaction_code DELETE /nucleus/v1/transaction_code/{transaction_code_id} Delete a transaction code
AtomApi::NucleusApi delete_transfer_request DELETE /nucleus/v1/transfer/{transfer_id} Delete a transfer request
AtomApi::NucleusApi delete_withdrawal_request DELETE /nucleus/v1/withdrawal/{withdrawal_id} Delete a withdrawal request
AtomApi::NucleusApi get_account GET /nucleus/v1/account/{account_id}/ Retrieve an account
AtomApi::NucleusApi get_account_allocation GET /nucleus/v1/account_allocation/{account_allocation_id} Retrieve an account allocation
AtomApi::NucleusApi get_account_allocations GET /nucleus/v1/account_allocation List all account allocations
AtomApi::NucleusApi get_account_asset_sizes GET /nucleus/v1/account/{account_id}/asset_size List all account asset sizes
AtomApi::NucleusApi get_account_holdings GET /nucleus/v1/account/{account_id}/holding List all account holdings
AtomApi::NucleusApi get_account_performance GET /nucleus/v1/account/{account_id}/performance Get account performance
AtomApi::NucleusApi get_account_permission GET /nucleus/v1/account_permission/{account_id} Retrieve an account's permission
AtomApi::NucleusApi get_account_permissions GET /nucleus/v1/account_permission List all account permissions
AtomApi::NucleusApi get_account_stage GET /nucleus/v1/stage/{stage_id} Retrieve an account stage
AtomApi::NucleusApi get_account_stages GET /nucleus/v1/stage List all account stages
AtomApi::NucleusApi get_account_status GET /nucleus/v1/account_status/{account_status_id} Retrieve an account status
AtomApi::NucleusApi get_account_statuses GET /nucleus/v1/account_status List all account statuses
AtomApi::NucleusApi get_account_transactions GET /nucleus/v1/account/{account_id}/transaction List all account transactions
AtomApi::NucleusApi get_account_type GET /nucleus/v1/account_type/{account_type_id} Retrieve an account type
AtomApi::NucleusApi get_account_types GET /nucleus/v1/account_type List all account types
AtomApi::NucleusApi get_accounts GET /nucleus/v1/account Get information for all accounts for all clients defined for your firm
AtomApi::NucleusApi get_aggregation_account GET /nucleus/v1/aggregation_account/{aggregation_account_id} Retrieve an aggregation account
AtomApi::NucleusApi get_aggregation_account_balance GET /nucleus/v1/aggregation_account_balance/{aggregation_account_balance_id} Retrieve an aggregation account balance
AtomApi::NucleusApi get_aggregation_account_balances GET /nucleus/v1/aggregation_account_balance List all aggregation account balances
AtomApi::NucleusApi get_aggregation_accounts GET /nucleus/v1/aggregation_account List all aggregation accounts
AtomApi::NucleusApi get_allocation GET /nucleus/v1/allocation/{allocation_id} Retrieve an allocation
AtomApi::NucleusApi get_allocation_asset_sizes GET /nucleus/v1/allocation/{allocation_id}/asset_size List all allocation asset sizes
AtomApi::NucleusApi get_allocation_composition GET /nucleus/v1/allocation_composition/{allocation_composition_id} Retrieve an allocation composition
AtomApi::NucleusApi get_allocation_compositions GET /nucleus/v1/allocation_composition List all allocation compositions
AtomApi::NucleusApi get_allocation_holdings GET /nucleus/v1/allocation/{allocation_id}/holding List all allocation holdings
AtomApi::NucleusApi get_allocation_performance GET /nucleus/v1/allocation/{allocation_id}/performance Get allocation performance
AtomApi::NucleusApi get_allocation_transactions GET /nucleus/v1/allocation/{allocation_id}/transaction List all allocation transactions
AtomApi::NucleusApi get_allocations GET /nucleus/v1/allocation List all allocations
AtomApi::NucleusApi get_bank_link GET /nucleus/v1/bank_link/{bank_link_id} Retrieve a bank link
AtomApi::NucleusApi get_bank_links GET /nucleus/v1/bank_link List all bank links
AtomApi::NucleusApi get_benchmark GET /nucleus/v1/benchmark/{benchmark_id} Retrieve a benchmark
AtomApi::NucleusApi get_benchmark_asset_sizes GET /nucleus/v1/benchmark/{benchmark_id}/asset_size List all benchmark asset sizes
AtomApi::NucleusApi get_benchmark_performance GET /nucleus/v1/benchmark/{benchmark_id}/performance Get benchmark performance
AtomApi::NucleusApi get_benchmarks GET /nucleus/v1/benchmark List all benchmarks
AtomApi::NucleusApi get_bulk_orders GET /nucleus/v1/order_bulk List all bulk orders
AtomApi::NucleusApi get_client GET /nucleus/v1/client/{client_id} Retrieve a client
AtomApi::NucleusApi get_client_asset_sizes GET /nucleus/v1/client/{client_id}/asset_size List all client asset sizes
AtomApi::NucleusApi get_client_holdings GET /nucleus/v1/client/{client_id}/holding List all client holdings
AtomApi::NucleusApi get_client_hydro GET /nucleus/v1/client_hydro/{client_hydro_id} Retrieve a client-hydro relationship
AtomApi::NucleusApi get_client_hydros GET /nucleus/v1/client_hydro List all client-hydro relationships
AtomApi::NucleusApi get_client_performance GET /nucleus/v1/client/{client_id}/performance Get client performance
AtomApi::NucleusApi get_client_response GET /nucleus/v1/client_response/{client_response_id} Retrieve a client response
AtomApi::NucleusApi get_client_responses GET /nucleus/v1/client_response List all client responses
AtomApi::NucleusApi get_client_transactions GET /nucleus/v1/client/{client_id}/transaction List all client transactions
AtomApi::NucleusApi get_clients GET /nucleus/v1/client List all clients
AtomApi::NucleusApi get_decision_tree GET /nucleus/v1/decision_tree/{decision_tree_id} Retrieve a decision tree
AtomApi::NucleusApi get_decision_trees GET /nucleus/v1/decision_tree List all decision trees
AtomApi::NucleusApi get_deposit_request GET /nucleus/v1/deposit/{deposit_id} Retrieve a deposit request
AtomApi::NucleusApi get_deposit_requests GET /nucleus/v1/deposit List all deposit requests
AtomApi::NucleusApi get_funding_request GET /nucleus/v1/funding/{funding_id} Retrieve a funding request
AtomApi::NucleusApi get_funding_requests GET /nucleus/v1/funding List all funding requests
AtomApi::NucleusApi get_goal GET /nucleus/v1/goal/{goal_id} Retrieve a goal
AtomApi::NucleusApi get_goal_asset_sizes GET /nucleus/v1/goal/{goal_id}/asset_size List goal asset sizes
AtomApi::NucleusApi get_goal_holdings GET /goal/{goal_id}/holding List goal holdings
AtomApi::NucleusApi get_goal_performance GET /nucleus/v1/goal/{goal_id}/performance Get goal performance
AtomApi::NucleusApi get_goal_track_record GET /nucleus/v1/goal_track/{goal_track_id} Retrieve a goal track record
AtomApi::NucleusApi get_goal_track_records GET /nucleus/v1/goal_track List all goal track records
AtomApi::NucleusApi get_goal_transactions GET /nucleus/v1/goal/{goal_id}/transaction List goal transactions
AtomApi::NucleusApi get_goals GET /nucleus/v1/goal List all goals
AtomApi::NucleusApi get_model GET /nucleus/v1/model/{model_id} Retrieve a model
AtomApi::NucleusApi get_model_asset_size GET /nucleus/v1/model_asset_size/{model_asset_size_id} Retrieve a model asset size
AtomApi::NucleusApi get_model_asset_sizes GET /nucleus/v1/model_asset_size List all model asset sizes
AtomApi::NucleusApi get_model_comment GET /nucleus/v1/model_comment/{model_comment_id} Retrieve a model commentary
AtomApi::NucleusApi get_model_comments GET /nucleus/v1/model_comment List all model commentary
AtomApi::NucleusApi get_model_holding GET /nucleus/v1/model_holding/{model_holding_id} Retrieve a model holding
AtomApi::NucleusApi get_model_holdings GET /nucleus/v1/model_holding List all model holdings
AtomApi::NucleusApi get_model_performance GET /nucleus/v1/model/{model_id}/performance Get model performance
AtomApi::NucleusApi get_model_transaction GET /nucleus/v1/model_transaction/{model_transaction_id} Retrieve a model transaction
AtomApi::NucleusApi get_model_transactions GET /nucleus/v1/model_transaction List all model transactions
AtomApi::NucleusApi get_models GET /nucleus/v1/model List all models
AtomApi::NucleusApi get_node GET /nucleus/v1/node/{node_id} Retrieve a node
AtomApi::NucleusApi get_node_relationship GET /nucleus/v1/node_relationship/{node_relationship_id} Retrieve a node relationship
AtomApi::NucleusApi get_node_relationships GET /nucleus/v1/node_relationship List all node relationships
AtomApi::NucleusApi get_nodes GET /nucleus/v1/node List all nodes
AtomApi::NucleusApi get_order_record GET /nucleus/v1/order/{order_id} Retrieve an order record
AtomApi::NucleusApi get_order_records GET /nucleus/v1/order List all order records
AtomApi::NucleusApi get_order_status GET /nucleus/v1/order_status/{order_status_id} Retrieve an order status
AtomApi::NucleusApi get_order_statuses GET /nucleus/v1/order_status List all order statuses
AtomApi::NucleusApi get_order_tracking_record GET /nucleus/v1/order_track/{order_track_id} Retrieve an order tracking record
AtomApi::NucleusApi get_order_tracking_records GET /nucleus/v1/order_track List all order tracking records
AtomApi::NucleusApi get_portfolio GET /nucleus/v1/portfolio/{portfolio_id} Retrieve a portfolio
AtomApi::NucleusApi get_portfolio_asset_size GET /nucleus/v1/portfolio_asset_size/{portfolio_asset_size_id} Retrieve a portfolio asset size
AtomApi::NucleusApi get_portfolio_asset_sizes GET /nucleus/v1/portfolio_asset_size List all portfolio asset sizes
AtomApi::NucleusApi get_portfolio_comment GET /nucleus/v1/portfolio_comment/{portfolio_comment_id} Retrieve a portfolio commentary
AtomApi::NucleusApi get_portfolio_comments GET /nucleus/v1/portfolio_comment List all portfolio commentary
AtomApi::NucleusApi get_portfolio_holding GET /nucleus/v1/portfolio_holding/{portfolio_holding_id} Retrieve a portfolio holding
AtomApi::NucleusApi get_portfolio_holdings GET /nucleus/v1/portfolio_holding List all portfolio holdings
AtomApi::NucleusApi get_portfolio_performance GET /nucleus/v1/portfolio/{portfolio_id}/performance Get portfolio performance
AtomApi::NucleusApi get_portfolio_transaction GET /nucleus/v1/portfolio_transaction/{portfolio_transaction_id} Retrieve a portfolio transaction
AtomApi::NucleusApi get_portfolio_transactions GET /nucleus/v1/portfolio_transaction List all portfolio transactions
AtomApi::NucleusApi get_portfolios GET /nucleus/v1/portfolio List all portfolios
AtomApi::NucleusApi get_questionnaire GET /nucleus/v1/questionnaire/{questionnaire_id} Retrieve a questionnaire
AtomApi::NucleusApi get_questionnaires GET /nucleus/v1/questionnaire List all questionnaires
AtomApi::NucleusApi get_score GET /nucleus/v1/score/{score_id} Retrieve a score
AtomApi::NucleusApi get_scores GET /nucleus/v1/score List all scores
AtomApi::NucleusApi get_securities GET /nucleus/v1/security List all securities
AtomApi::NucleusApi get_security GET /nucleus/v1/security/{security_id} Retrieve a security
AtomApi::NucleusApi get_security_exclusion GET /nucleus/v1/security_exclusion/{security_exclusion_id} Retrieve a security exclusion
AtomApi::NucleusApi get_security_exclusions GET /nucleus/v1/security_exclusion List all security exclusions
AtomApi::NucleusApi get_security_performance GET /nucleus/v1/security/{security_id}/performance Get security performance
AtomApi::NucleusApi get_security_price GET /nucleus/v1/security_price/{security_price_id} Retrieve a security price
AtomApi::NucleusApi get_security_prices GET /nucleus/v1/security_price List all security prices
AtomApi::NucleusApi get_transaction_code GET /nucleus/v1/transaction_code/{transaction_code_id} Retrieve a transaction code
AtomApi::NucleusApi get_transaction_codes GET /nucleus/v1/transaction_code List all transaction codes
AtomApi::NucleusApi get_transfer_request GET /nucleus/v1/transfer/{transfer_id} Retrieve a transfer request
AtomApi::NucleusApi get_transfer_requests GET /nucleus/v1/transfer List all transfer requests
AtomApi::NucleusApi get_withdrawal_request GET /nucleus/v1/withdrawal/{withdrawal_id} Retrieve a withdrawal request
AtomApi::NucleusApi get_withdrawal_requests GET /nucleus/v1/withdrawal List all withdrawal requests
AtomApi::NucleusApi post_account POST /nucleus/v1/account Create an account under a client
AtomApi::NucleusApi post_account_allocation POST /nucleus/v1/account_allocation Create an account allocation
AtomApi::NucleusApi post_account_bulk_order POST /nucleus/v1/account/{account_id}/order_bulk Bulk orders for an account
AtomApi::NucleusApi post_account_rebalance_buy_only_order POST /nucleus/v1/account/{account_id}/order_buy_only Create buy-only account rebalance orders
AtomApi::NucleusApi post_account_rebalance_order POST /nucleus/v1/account/{account_id}/order_rebalance Create account rebalance orders
AtomApi::NucleusApi post_account_rebalance_sell_only_order POST /nucleus/v1/account/{account_id}/order_sell_only Create sell-only account rebalance orders
AtomApi::NucleusApi post_account_sell_all_order POST /nucleus/v1/account/{account_id}/order_sell_all Sell all account order
AtomApi::NucleusApi post_account_stage POST /nucleus/v1/stage Create an account stage
AtomApi::NucleusApi post_account_status POST /nucleus/v1/account_status Create an account status
AtomApi::NucleusApi post_account_type POST /nucleus/v1/account_type Create an account type
AtomApi::NucleusApi post_aggregation_account POST /nucleus/v1/aggregation_account Create an aggregation account
AtomApi::NucleusApi post_aggregation_account_balance POST /nucleus/v1/aggregation_account_balance Create an aggregation account balance
AtomApi::NucleusApi post_allocation POST /nucleus/v1/allocation Create an allocation
AtomApi::NucleusApi post_allocation_composition POST /nucleus/v1/allocation_composition Create an allocation composition
AtomApi::NucleusApi post_bank_link POST /nucleus/v1/bank_link Create a bank link
AtomApi::NucleusApi post_benchmark POST /nucleus/v1/benchmark Create a benchmark
AtomApi::NucleusApi post_bulk_order POST /nucleus/v1/order_bulk Bulk orders for your firm
AtomApi::NucleusApi post_client POST /nucleus/v1/client Create a client
AtomApi::NucleusApi post_client_bulk_order POST /nucleus/v1/client/{client_id}/order_bulk Bulk orders for a client
AtomApi::NucleusApi post_client_hydro POST /nucleus/v1/client_hydro Create a client-hydro relationship
AtomApi::NucleusApi post_client_response POST /nucleus/v1/client_response Create a client response
AtomApi::NucleusApi post_decision_tree POST /nucleus/v1/decision_tree Create a decision tree
AtomApi::NucleusApi post_deposit_request POST /nucleus/v1/deposit Create a deposit request
AtomApi::NucleusApi post_funding_request POST /nucleus/v1/funding Create a funding request
AtomApi::NucleusApi post_goal POST /nucleus/v1/goal Create a goal
AtomApi::NucleusApi post_goal_track_record POST /nucleus/v1/goal_track Create a goal track record
AtomApi::NucleusApi post_model POST /nucleus/v1/model Create a model
AtomApi::NucleusApi post_model_asset_size POST /nucleus/v1/model_asset_size Create a model asset size
AtomApi::NucleusApi post_model_comment POST /nucleus/v1/model_comment Create a model commentary
AtomApi::NucleusApi post_model_holding POST /nucleus/v1/model_holding Create a model holding
AtomApi::NucleusApi post_model_transaction POST /nucleus/v1/model_transaction Create a model transaction
AtomApi::NucleusApi post_node POST /nucleus/v1/node Create a node
AtomApi::NucleusApi post_node_relationship POST /nucleus/v1/node_relationship Create a node relationship
AtomApi::NucleusApi post_order_record POST /nucleus/v1/order Create an order record
AtomApi::NucleusApi post_order_status POST /nucleus/v1/order_status Create an order status
AtomApi::NucleusApi post_order_tracking_record POST /nucleus/v1/order_track Create an order tracking record
AtomApi::NucleusApi post_portfolio POST /nucleus/v1/portfolio Create a portfolio
AtomApi::NucleusApi post_portfolio_asset_size POST /nucleus/v1/portfolio_asset_size Create a portfolio asset size
AtomApi::NucleusApi post_portfolio_comment POST /nucleus/v1/portfolio_comment Create a portfolio commentary
AtomApi::NucleusApi post_portfolio_holding POST /nucleus/v1/portfolio_holding Create a portfolio holding
AtomApi::NucleusApi post_portfolio_rebalance_buy_only_order POST /nucleus/v1/portfolio/{portfolio_id}/order_buy_only Create buy-only portfolio rebalance orders
AtomApi::NucleusApi post_portfolio_rebalance_order POST /nucleus/v1/portfolio/{portfolio_id}/order_rebalance Create portfolio rebalance orders
AtomApi::NucleusApi post_portfolio_rebalance_sell_only_order POST /nucleus/v1/portfolio/{portfolio_id}/order_sell_only Create sell-only portfolio rebalance orders
AtomApi::NucleusApi post_portfolio_sell_all_order POST /nucleus/v1/portfolio/{portfolio_id}/order_sell_all Sell all portfolio order
AtomApi::NucleusApi post_portfolio_transaction POST /nucleus/v1/portfolio_transaction Create a portfolio transaction
AtomApi::NucleusApi post_questionnaire POST /nucleus/v1/questionnaire Create a questionnaire
AtomApi::NucleusApi post_score POST /nucleus/v1/score Create a score
AtomApi::NucleusApi post_security POST /nucleus/v1/security Create a security
AtomApi::NucleusApi post_security_exclusion POST /nucleus/v1/security_exclusion Create a security exclusion
AtomApi::NucleusApi post_security_price POST /nucleus/v1/security_price Create a security price
AtomApi::NucleusApi post_transaction_code POST /nucleus/v1/transaction_code Create a transaction code
AtomApi::NucleusApi post_transfer_request POST /nucleus/v1/transfer Create a transfer request
AtomApi::NucleusApi post_withdrawal_request POST /nucleus/v1/withdrawal Create a withdrawal request
AtomApi::NucleusApi subscribe_account POST /nucleus/v1/account/{account_id}/subscribe Subscribe an account
AtomApi::NucleusApi update_account PUT /nucleus/v1/account/{account_id}/ Update an account
AtomApi::NucleusApi update_account_allocation PUT /nucleus/v1/account_allocation/{account_allocation_id} Update an account allocation
AtomApi::NucleusApi update_account_permission PUT /nucleus/v1/account_permission/{account_id} Update an account's permissions
AtomApi::NucleusApi update_account_stage PUT /nucleus/v1/stage/{stage_id} Update an account stage
AtomApi::NucleusApi update_account_status PUT /nucleus/v1/account_status/{account_status_id} Update an account status
AtomApi::NucleusApi update_account_type PUT /nucleus/v1/account_type/{account_type_id} Update an account type
AtomApi::NucleusApi update_aggregation_account PUT /nucleus/v1/aggregation_account/{aggregation_account_id} Update an aggregation account
AtomApi::NucleusApi update_aggregation_account_balance PUT /nucleus/v1/aggregation_account_balance/{aggregation_account_balance_id} Update an aggregation account balance
AtomApi::NucleusApi update_allocation PUT /nucleus/v1/allocation/{allocation_id} Update an allocation
AtomApi::NucleusApi update_allocation_composition PUT /nucleus/v1/allocation_composition/{allocation_composition_id} Update an allocation composition
AtomApi::NucleusApi update_bank_link PUT /nucleus/v1/bank_link/{bank_link_id} Update a bank link
AtomApi::NucleusApi update_benchmark PUT /nucleus/v1/benchmark/{benchmark_id} Update a benchmark
AtomApi::NucleusApi update_client PUT /nucleus/v1/client/{client_id} Update a client
AtomApi::NucleusApi update_client_hydro PUT /nucleus/v1/client_hydro/{client_hydro_id} Update a client-hydro relationship
AtomApi::NucleusApi update_client_response PUT /nucleus/v1/client_response/{client_response_id} Update a client response
AtomApi::NucleusApi update_decision_tree PUT /nucleus/v1/decision_tree/{decision_tree_id} Update a decision tree
AtomApi::NucleusApi update_deposit_request PUT /nucleus/v1/deposit/{deposit_id} Update a deposit request
AtomApi::NucleusApi update_funding_request PUT /nucleus/v1/funding/{funding_id} Update a funding request
AtomApi::NucleusApi update_goal PUT /nucleus/v1/goal/{goal_id} Update a goal
AtomApi::NucleusApi update_goal_track_record PUT /nucleus/v1/goal_track/{goal_track_id} Update a goal track record
AtomApi::NucleusApi update_model PUT /nucleus/v1/model/{model_id} Update a model
AtomApi::NucleusApi update_model_asset_size PUT /nucleus/v1/model_asset_size/{model_asset_size_id} Update a model asset size
AtomApi::NucleusApi update_model_comment PUT /nucleus/v1/model_comment/{model_comment_id} Update a model commentary
AtomApi::NucleusApi update_model_composition POST /nucleus/v1/model/{model_id}/model_change Change a model composition
AtomApi::NucleusApi update_model_holding PUT /nucleus/v1/model_holding/{model_holding_id} Update a model holding
AtomApi::NucleusApi update_model_transaction PUT /nucleus/v1/model_transaction/{model_transaction_id} Update a model transaction
AtomApi::NucleusApi update_node PUT /nucleus/v1/node/{node_id} Update a node
AtomApi::NucleusApi update_node_relationship PUT /nucleus/v1/node_relationship/{node_relationship_id} Update a node relationship
AtomApi::NucleusApi update_order_record PUT /nucleus/v1/order/{order_id} Update an order record
AtomApi::NucleusApi update_order_status PUT /nucleus/v1/order_status/{order_status_id} Update an order status
AtomApi::NucleusApi update_order_tracking_record PUT /nucleus/v1/order_track/{order_track_id} Update an order tracking record
AtomApi::NucleusApi update_portfolio PUT /nucleus/v1/portfolio/{portfolio_id} Update a portfolio
AtomApi::NucleusApi update_portfolio_asset_size PUT /nucleus/v1/portfolio_asset_size/{portfolio_asset_size_id} Update a portfolio asset size
AtomApi::NucleusApi update_portfolio_comment PUT /nucleus/v1/portfolio_comment/{portfolio_comment_id} Update a portfolio commentary
AtomApi::NucleusApi update_portfolio_holding PUT /nucleus/v1/portfolio_holding/{portfolio_holding_id} Update a portfolio holding
AtomApi::NucleusApi update_portfolio_transaction PUT /nucleus/v1/portfolio_transaction/{portfolio_transaction_id} Update a portfolio transaction
AtomApi::NucleusApi update_questionnaire PUT /nucleus/v1/questionnaire/{questionnaire_id} Update a questionnaire
AtomApi::NucleusApi update_score PUT /nucleus/v1/score/{score_id} Update a score
AtomApi::NucleusApi update_security PUT /nucleus/v1/security/{security_id} Update a security
AtomApi::NucleusApi update_security_exclusion PUT /nucleus/v1/security_exclusion/{security_exclusion_id} Update a security exclusion
AtomApi::NucleusApi update_security_price PUT /nucleus/v1/security_price/{security_price_id} Update a security price
AtomApi::NucleusApi update_transaction_code PUT /nucleus/v1/transaction_code/{transaction_code_id} Update a transaction code
AtomApi::NucleusApi update_transfer_request PUT /nucleus/v1/transfer/{transfer_id} Update a transfer request
AtomApi::NucleusApi update_withdrawal_request PUT /nucleus/v1/withdrawal/{withdrawal_id} Update a withdrawal request
AtomApi::ProtonApi annuity_calculator_accumulation_horizon POST /proton/v1/annuity_calculator/accumulation_horizon Annuity calculator - accumulation horizon
AtomApi::ProtonApi annuity_calculator_annuity_amount POST /proton/v1/annuity_calculator/annuity_amount Annuity calculator - annuity amount
AtomApi::ProtonApi annuity_calculator_decumulation_horizon POST /proton/v1/annuity_calculator/decumulation_horizon Annuity calculator - decumulation horizon
AtomApi::ProtonApi annuity_calculator_deposit_amount POST /proton/v1/annuity_calculator/deposit_amount Annuity calculator - deposit amount
AtomApi::ProtonApi annuity_calculator_initial_balance POST /proton/v1/annuity_calculator/initial_balance Annuity calculator - initial balance
AtomApi::ProtonApi dimensional_risk_score POST /proton/v1/dimensional_risk_score Dimensional risk score
AtomApi::ProtonApi education_calculator_annual_cost POST /proton/v1/education_calculator/annual_cost Education calculator - total annual cost
AtomApi::ProtonApi education_calculator_deposit_amount POST /proton/v1/education_calculator/deposit_amount Education calculator - deposit amount
AtomApi::ProtonApi education_calculator_percent_covered POST /proton/v1/education_calculator/percent_covered Education calculator - percent covered
AtomApi::ProtonApi emergency_fund_calculator POST /proton/v1/emergency_fund_calculator Emergency fund calculator
AtomApi::ProtonApi event_study POST /proton/v1/event_study Event study
AtomApi::ProtonApi financial_health_check POST /proton/v1/financial_health_check Financial health check
AtomApi::ProtonApi goal_accumulation_allocation POST /proton/v1/goal_accumulation/allocation Goal accumulation allocation
AtomApi::ProtonApi goal_accumulation_recommendation POST /proton/v1/goal_accumulation/recommendation Goal accumulation recommendation
AtomApi::ProtonApi goal_accumulation_status POST /proton/v1/goal_accumulation/status Goal accumulation status
AtomApi::ProtonApi goal_decumulation_allocation POST /proton/v1/goal_decumulation/allocation Goal decumulation allocation
AtomApi::ProtonApi goal_decumulation_recommendation POST /proton/v1/goal_decumulation/recommendation Goal decumulation recommendation
AtomApi::ProtonApi goal_decumulation_status POST /proton/v1/goal_decumulation/status Goal decumulation status
AtomApi::ProtonApi life_insurance_needs_calculator POST /proton/v1/life_insurance/needs_calculator Life insurance needs calculator
AtomApi::ProtonApi model_backtest POST /proton/v1/backtest Model backtest
AtomApi::ProtonApi monte_carlo POST /proton/v1/monte_carlo Monte Carlo
AtomApi::ProtonApi mortgage_calculator_down_payment POST /proton/v1/mortgage_calculator/down_payment Mortgage calculator - down payment
AtomApi::ProtonApi mortgage_calculator_home_price POST /proton/v1/mortgage_calculator/home_price Mortgage calculator - home price
AtomApi::ProtonApi mortgage_calculator_periodic_payment POST /proton/v1/mortgage_calculator/periodic_payment Mortgage calculator - periodic payment
AtomApi::ProtonApi mvo POST /proton/v1/mvo Mean-variance optimization
AtomApi::ProtonApi portfolio_diversification_score POST /proton/v1/diversification_score Portfolio diversification score
AtomApi::ProtonApi portfolio_optimization_score POST /proton/v1/portfolio_optimization_score Portfolio optimization score
AtomApi::ProtonApi portfolio_what_if POST /proton/v1/portfolio_what_if Portfolio what-if
AtomApi::ProtonApi purchase_calculator_deposit_amount POST /proton/v1/purchase_calculator/deposit_amount Purchase calculator - deposit amount
AtomApi::ProtonApi purchase_calculator_horizon POST /proton/v1/purchase_calculator/horizon Purchase calculator - horizon
AtomApi::ProtonApi purchase_calculator_purchase_amount POST /proton/v1/purchase_calculator/amount Purchase calculator - purchase amount
AtomApi::ProtonApi rebalancing_signal POST /proton/v1/rebalancing_signal Rebalancing
AtomApi::ProtonApi retirement_calculator_deposit_amount POST /proton/v1/retirement_calculator/deposit_amount Retirement calculator - deposit amount
AtomApi::ProtonApi retirement_calculator_expenses POST /proton/v1/retirement_calculator/expenses Retirement calculator - expenses
AtomApi::ProtonApi retirement_calculator_percent_covered POST /proton/v1/retirement_calculator/percent_covered Retirement calculator - percent of costs covered
AtomApi::ProtonApi risk_allocation POST /proton/v1/risk_allocation Risk allocation
AtomApi::ProtonApi risk_score POST /proton/v1/risk_score Risk score
AtomApi::ProtonApi savings_calculator POST /proton/v1/savings_calculator Savings calculator
AtomApi::ProtonApi scenario_analysis POST /proton/v1/scenario_analysis Scenario analysis
AtomApi::ProtonApi sensitivity_analysis POST /proton/v1/sensitivity_analysis Sensitivity analysis

Documentation for Models

Documentation for Authorization

Please see this page for additional authorization information.

oauth

Author

https://www.hydrogenplatform.com/

You can’t perform that action at this time.