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
src Add SDKs Apr 9, 2019
test Add SDKs Apr 9, 2019
.swagger-codegen-ignore Add SDKs Apr 9, 2019
.travis.yml Add SDKs Apr 9, 2019
README.md Add SDKs Apr 9, 2019
git_push.sh Add SDKs Apr 9, 2019
mocha.opts Add SDKs Apr 9, 2019
package.json Add SDKs Apr 9, 2019

README.md

hydrogen-atom-api

atom_api - JavaScript client for hydrogen-atom-api

The Hydrogen Atom API

Full documentation: Nucleus | Electron | Proton

This SDK is automatically generated by the Swagger Codegen project:

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install hydrogen-atom-api --save

Optionally, install client-oauth2 for easier authentication (see Method 1 in Getting Started):

npm install --save client-oauth2
Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your hydrogen-atom-api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('hydrogen-atom-api') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Full usage documentation is available: Nucleus | Electron | Proton

Please follow the installation instructions and execute the following JS code:

var atom_api = require('hydrogen-atom-api');

var defaultClient = atom_api.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth

// Method 1: Fetch and set access token with client_id and client_secret (requires npm client-oauth2)

// Initialize the OAuth2 Library
var ClientOAuth2 = require('client-oauth2')

// Set the configuration settings
var auth = new ClientOAuth2({
  clientId: '<your clientId>',
  clientSecret: '<your clientSecret>',
  accessTokenUri: 'https://api.hydrogenplatform.com/authorization/v1/oauth/token?grant_type=client_credentials',
})

// Get the access token object for the client
try {
  auth.credentials.getToken()
    .then(function (user) {
      defaultClient.authentications['oauth']['accessToken'] = user.accessToken;
} catch (error) {
    console.log('Access Token error', error.message);
}

// Method 2: Set access token using an existing token
var oauth = defaultClient.authentications['oauth'];
oauth.accessToken = "YOUR ACCESS TOKEN"

var api = new atom_api.ElectronApi()

var campaignId = "campaignId_example"; // {String} UUID of a marketing campaign


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteCampaign(campaignId, callback);

Documentation for API Endpoints

Full usage documentation is available: Nucleus | Electron | Proton

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

Class Method HTTP request Description
atom_api.ElectronApi deleteCampaign DELETE /electron/v1/campaign/{campaign_id} Delete a marketing campaign
atom_api.ElectronApi deleteCampaignDataRecord DELETE /electron/v1/campaign_data/{campaign_data_id} Delete a marketing campaign data record
atom_api.ElectronApi deleteCampaignPlan DELETE /electron/v1/campaign_plan/{campaign_plan_id} Delete a marketing campaign plan
atom_api.ElectronApi deleteChatLog DELETE /electron/v1/chat/{chat_id} Delete a chat log
atom_api.ElectronApi deleteClientCampaign DELETE /electron/v1/client_campaign/{client_campaign_id} Remove a client from a campaign
atom_api.ElectronApi deleteConsultation DELETE /electron/v1/consultation/{consultation_id} Delete a consultation
atom_api.ElectronApi deleteDocument DELETE /electron/v1/document/{document_id} Delete a document
atom_api.ElectronApi deleteFaq DELETE /electron/v1/faq/{faq_id} Delete a FAQ
atom_api.ElectronApi deleteSalesInquiry DELETE /electron/v1/sales/{sales_id} Delete a sales inquiry
atom_api.ElectronApi deleteSupportTicket DELETE /electron/v1/support_ticket/{support_ticket_id} Delete a support ticket
atom_api.ElectronApi deleteSupportTicketComment DELETE /electron/v1/support_ticket_comment/{support_ticket_comment_id} Delete a support ticket comment
atom_api.ElectronApi getCampaign GET /electron/v1/campaign/{campaign_id} Retrieve a marketing campaign
atom_api.ElectronApi getCampaignDataRecord GET /electron/v1/campaign_data/{campaign_data_id} Retrieve a marketing campaign data record
atom_api.ElectronApi getCampaignDataRecords GET /electron/v1/campaign_data List all marketing campaign data records
atom_api.ElectronApi getCampaignPlan GET /electron/v1/campaign_plan/{campaign_plan_id} Retrieve a marketing campaign plan
atom_api.ElectronApi getCampaignPlans GET /electron/v1/campaign_plan List all marketing campaign plans
atom_api.ElectronApi getCampaigns GET /electron/v1/campaign List all marketing campaigns
atom_api.ElectronApi getChatLog GET /electron/v1/chat/{chat_id} Retrieve a chat log
atom_api.ElectronApi getChatLogs GET /electron/v1/chat List all chat logs
atom_api.ElectronApi getClientCampaign GET /electron/v1/client_campaign/{client_campaign_id} Retrieve a client assigned to a campaign
atom_api.ElectronApi getClientCampaigns GET /electron/v1/client_campaign List information for all clients that are assigned to a marketing campaign defined for your firm
atom_api.ElectronApi getConsultation GET /electron/v1/consultation/{consultation_id} Retrieve a consultation
atom_api.ElectronApi getConsultations GET /electron/v1/consultation List all consultations
atom_api.ElectronApi getDocument GET /electron/v1/document/{document_id} Retrieve a document
atom_api.ElectronApi getDocuments GET /electron/v1/document List all documents
atom_api.ElectronApi getFaq GET /electron/v1/faq/{faq_id} Retrieve a FAQ
atom_api.ElectronApi getFaqs GET /electron/v1/faq List all FAQs
atom_api.ElectronApi getSalesInquiries GET /electron/v1/sales List all sales inquiries
atom_api.ElectronApi getSalesInquiry GET /electron/v1/sales/{sales_id} Retrieve a sales inquiry
atom_api.ElectronApi getSupportTicket GET /electron/v1/support_ticket/{support_ticket_id} Retrieve a support ticket
atom_api.ElectronApi getSupportTicketComment GET /electron/v1/support_ticket_comment/{support_ticket_comment_id} Retrieve a support ticket comment
atom_api.ElectronApi getSupportTicketComments GET /electron/v1/support_ticket_comment List all support ticket comments
atom_api.ElectronApi getSupportTickets GET /electron/v1/support_ticket List all support tickets
atom_api.ElectronApi postCampaign POST /electron/v1/campaign Create a marketing campaign
atom_api.ElectronApi postCampaignDataRecord POST /electron/v1/campaign_data Create a marketing campaign data record
atom_api.ElectronApi postCampaignPlan POST /electron/v1/campaign_plan Create a marketing campaign plan
atom_api.ElectronApi postChatLog POST /electron/v1/chat Create a chat log
atom_api.ElectronApi postClientCampaign POST /electron/v1/client_campaign Assign a client to a campaign to indicate the client has registered through the campaign specified
atom_api.ElectronApi postConsultation POST /electron/v1/consultation Create a consultation
atom_api.ElectronApi postDocument POST /electron/v1/document Create a document
atom_api.ElectronApi postFaq POST /electron/v1/faq Create a faq
atom_api.ElectronApi postSalesInquiry POST /electron/v1/sales Create a sales inquiry
atom_api.ElectronApi postSupportTicket POST /electron/v1/support_ticket Create a support ticket
atom_api.ElectronApi postSupportTicketComment POST /electron/v1/support_ticket_comment Create a support ticket comment
atom_api.ElectronApi updateCampaign PUT /electron/v1/campaign/{campaign_id} Update a marketing campaign
atom_api.ElectronApi updateCampaignDataRecord PUT /electron/v1/campaign_data/{campaign_data_id} Update a marketing campaign data record
atom_api.ElectronApi updateCampaignPlan PUT /electron/v1/campaign_plan/{campaign_plan_id} Update a marketing campaign plan
atom_api.ElectronApi updateChatLog PUT /electron/v1/chat/{chat_id} Update a chat log
atom_api.ElectronApi updateClientCampaign PUT /electron/v1/client_campaign/{client_campaign_id} Update a client assigned to a campaign
atom_api.ElectronApi updateConsultation PUT /electron/v1/consultation/{consultation_id} Update a consultation
atom_api.ElectronApi updateDocument PUT /electron/v1/document/{document_id} Update a document
atom_api.ElectronApi updateFaq PUT /electron/v1/faq/{faq_id} Update a FAQ
atom_api.ElectronApi updateSalesInquiry PUT /electron/v1/sales/{sales_id} Update a sales inquiry
atom_api.ElectronApi updateSupportTicket PUT /electron/v1/support_ticket/{support_ticket_id} Update a support ticket
atom_api.ElectronApi updateSupportTicketComment PUT /electron/v1/support_ticket_comment/{support_ticket_comment_id} Update a support ticket comment
atom_api.NucleusApi deleteAccount DELETE /nucleus/v1/account/{account_id}/ Delete an account
atom_api.NucleusApi deleteAccountAllocation DELETE /nucleus/v1/account_allocation/{account_allocation_id} Delete an account allocation
atom_api.NucleusApi deleteAccountPermission DELETE /nucleus/v1/account_permission/{account_id} Delete an account's permissions
atom_api.NucleusApi deleteAccountStage DELETE /nucleus/v1/stage/{stage_id} Delete an account stage
atom_api.NucleusApi deleteAccountStatus DELETE /nucleus/v1/account_status/{account_status_id} Delete an account status
atom_api.NucleusApi deleteAccountType DELETE /nucleus/v1/account_type/{account_type_id} Delete an account type
atom_api.NucleusApi deleteAggregationAccount DELETE /nucleus/v1/aggregation_account/{aggregation_account_id} Delete an aggregation account
atom_api.NucleusApi deleteAggregationAccountBalance DELETE /nucleus/v1/aggregation_account_balance/{aggregation_account_balance_id} Delete an aggregation account balance
atom_api.NucleusApi deleteAllocation DELETE /nucleus/v1/allocation/{allocation_id} Delete an allocation
atom_api.NucleusApi deleteAllocationComposition DELETE /nucleus/v1/allocation_composition/{allocation_composition_id} Delete an allocation composition
atom_api.NucleusApi deleteBankLink DELETE /nucleus/v1/bank_link/{bank_link_id} Delete a bank link
atom_api.NucleusApi deleteBenchmark DELETE /nucleus/v1/benchmark/{benchmark_id} Delete a benchmark
atom_api.NucleusApi deleteClient DELETE /nucleus/v1/client/{client_id} Delete a client
atom_api.NucleusApi deleteClientHydro DELETE /nucleus/v1/client_hydro/{client_hydro_id} Delete a client-hydro relationship
atom_api.NucleusApi deleteClientResponse DELETE /nucleus/v1/client_response/{client_response_id} Delete a client response
atom_api.NucleusApi deleteDecisionTree DELETE /nucleus/v1/decision_tree/{decision_tree_id} Delete a decision tree
atom_api.NucleusApi deleteDepositRequest DELETE /nucleus/v1/deposit/{deposit_id} Delete a deposit request
atom_api.NucleusApi deleteFundingRequest DELETE /nucleus/v1/funding/{funding_id} Delete a funding request
atom_api.NucleusApi deleteGoal DELETE /nucleus/v1/goal/{goal_id} Delete a goal
atom_api.NucleusApi deleteGoalTrackRecord DELETE /nucleus/v1/goal_track/{goal_track_id} Delete a goal track record
atom_api.NucleusApi deleteModel DELETE /nucleus/v1/model/{model_id} Delete a model
atom_api.NucleusApi deleteModelAssetSize DELETE /nucleus/v1/model_asset_size/{model_asset_size_id} Delete a model asset size
atom_api.NucleusApi deleteModelComment DELETE /nucleus/v1/model_comment/{model_comment_id} Delete a model commentary
atom_api.NucleusApi deleteModelHolding DELETE /nucleus/v1/model_holding/{model_holding_id} Delete a model holding
atom_api.NucleusApi deleteModelTransaction DELETE /nucleus/v1/model_transaction/{model_transaction_id} Delete a model transaction
atom_api.NucleusApi deleteNode DELETE /nucleus/v1/node/{node_id} Delete a node
atom_api.NucleusApi deleteNodeRelationship DELETE /nucleus/v1/node_relationship/{node_relationship_id} Delete a node relationship
atom_api.NucleusApi deleteOrderRecord DELETE /nucleus/v1/order/{order_id} Delete an order record
atom_api.NucleusApi deleteOrderStatus DELETE /nucleus/v1/order_status/{order_status_id} Delete an order status
atom_api.NucleusApi deleteOrderTrackingRecord DELETE /nucleus/v1/order_track/{order_track_id} Delete an order tracking record
atom_api.NucleusApi deletePortfolio DELETE /nucleus/v1/portfolio/{portfolio_id} Delete a portfolio
atom_api.NucleusApi deletePortfolioAssetSize DELETE /nucleus/v1/portfolio_asset_size/{portfolio_asset_size_id} Delete a portfolio asset size
atom_api.NucleusApi deletePortfolioComment DELETE /nucleus/v1/portfolio_comment/{portfolio_comment_id} Delete a portfolio commentary
atom_api.NucleusApi deletePortfolioHolding DELETE /nucleus/v1/portfolio_holding/{portfolio_holding_id} Delete a portfolio holding
atom_api.NucleusApi deletePortfolioTransaction DELETE /nucleus/v1/portfolio_transaction/{portfolio_transaction_id} Delete a portfolio transaction
atom_api.NucleusApi deleteQuestionnaire DELETE /nucleus/v1/questionnaire/{questionnaire_id} Delete a questionnaire
atom_api.NucleusApi deleteScore DELETE /nucleus/v1/score/{score_id} Delete a score
atom_api.NucleusApi deleteSecurity DELETE /nucleus/v1/security/{security_id} Delete a security
atom_api.NucleusApi deleteSecurityExclusion DELETE /nucleus/v1/security_exclusion/{security_exclusion_id} Delete a security exclusion
atom_api.NucleusApi deleteSecurityPrice DELETE /nucleus/v1/security_price/{security_price_id} Delete a security price
atom_api.NucleusApi deleteTransactionCode DELETE /nucleus/v1/transaction_code/{transaction_code_id} Delete a transaction code
atom_api.NucleusApi deleteTransferRequest DELETE /nucleus/v1/transfer/{transfer_id} Delete a transfer request
atom_api.NucleusApi deleteWithdrawalRequest DELETE /nucleus/v1/withdrawal/{withdrawal_id} Delete a withdrawal request
atom_api.NucleusApi getAccount GET /nucleus/v1/account/{account_id}/ Retrieve an account
atom_api.NucleusApi getAccountAllocation GET /nucleus/v1/account_allocation/{account_allocation_id} Retrieve an account allocation
atom_api.NucleusApi getAccountAllocations GET /nucleus/v1/account_allocation List all account allocations
atom_api.NucleusApi getAccountAssetSizes GET /nucleus/v1/account/{account_id}/asset_size List all account asset sizes
atom_api.NucleusApi getAccountHoldings GET /nucleus/v1/account/{account_id}/holding List all account holdings
atom_api.NucleusApi getAccountPerformance GET /nucleus/v1/account/{account_id}/performance Get account performance
atom_api.NucleusApi getAccountPermission GET /nucleus/v1/account_permission/{account_id} Retrieve an account's permission
atom_api.NucleusApi getAccountPermissions GET /nucleus/v1/account_permission List all account permissions
atom_api.NucleusApi getAccountStage GET /nucleus/v1/stage/{stage_id} Retrieve an account stage
atom_api.NucleusApi getAccountStages GET /nucleus/v1/stage List all account stages
atom_api.NucleusApi getAccountStatus GET /nucleus/v1/account_status/{account_status_id} Retrieve an account status
atom_api.NucleusApi getAccountStatuses GET /nucleus/v1/account_status List all account statuses
atom_api.NucleusApi getAccountTransactions GET /nucleus/v1/account/{account_id}/transaction List all account transactions
atom_api.NucleusApi getAccountType GET /nucleus/v1/account_type/{account_type_id} Retrieve an account type
atom_api.NucleusApi getAccountTypes GET /nucleus/v1/account_type List all account types
atom_api.NucleusApi getAccounts GET /nucleus/v1/account Get information for all accounts for all clients defined for your firm
atom_api.NucleusApi getAggregationAccount GET /nucleus/v1/aggregation_account/{aggregation_account_id} Retrieve an aggregation account
atom_api.NucleusApi getAggregationAccountBalance GET /nucleus/v1/aggregation_account_balance/{aggregation_account_balance_id} Retrieve an aggregation account balance
atom_api.NucleusApi getAggregationAccountBalances GET /nucleus/v1/aggregation_account_balance List all aggregation account balances
atom_api.NucleusApi getAggregationAccounts GET /nucleus/v1/aggregation_account List all aggregation accounts
atom_api.NucleusApi getAllocation GET /nucleus/v1/allocation/{allocation_id} Retrieve an allocation
atom_api.NucleusApi getAllocationAssetSizes GET /nucleus/v1/allocation/{allocation_id}/asset_size List all allocation asset sizes
atom_api.NucleusApi getAllocationComposition GET /nucleus/v1/allocation_composition/{allocation_composition_id} Retrieve an allocation composition
atom_api.NucleusApi getAllocationCompositions GET /nucleus/v1/allocation_composition List all allocation compositions
atom_api.NucleusApi getAllocationHoldings GET /nucleus/v1/allocation/{allocation_id}/holding List all allocation holdings
atom_api.NucleusApi getAllocationPerformance GET /nucleus/v1/allocation/{allocation_id}/performance Get allocation performance
atom_api.NucleusApi getAllocationTransactions GET /nucleus/v1/allocation/{allocation_id}/transaction List all allocation transactions
atom_api.NucleusApi getAllocations GET /nucleus/v1/allocation List all allocations
atom_api.NucleusApi getBankLink GET /nucleus/v1/bank_link/{bank_link_id} Retrieve a bank link
atom_api.NucleusApi getBankLinks GET /nucleus/v1/bank_link List all bank links
atom_api.NucleusApi getBenchmark GET /nucleus/v1/benchmark/{benchmark_id} Retrieve a benchmark
atom_api.NucleusApi getBenchmarkAssetSizes GET /nucleus/v1/benchmark/{benchmark_id}/asset_size List all benchmark asset sizes
atom_api.NucleusApi getBenchmarkPerformance GET /nucleus/v1/benchmark/{benchmark_id}/performance Get benchmark performance
atom_api.NucleusApi getBenchmarks GET /nucleus/v1/benchmark List all benchmarks
atom_api.NucleusApi getBulkOrders GET /nucleus/v1/order_bulk List all bulk orders
atom_api.NucleusApi getClient GET /nucleus/v1/client/{client_id} Retrieve a client
atom_api.NucleusApi getClientAssetSizes GET /nucleus/v1/client/{client_id}/asset_size List all client asset sizes
atom_api.NucleusApi getClientHoldings GET /nucleus/v1/client/{client_id}/holding List all client holdings
atom_api.NucleusApi getClientHydro GET /nucleus/v1/client_hydro/{client_hydro_id} Retrieve a client-hydro relationship
atom_api.NucleusApi getClientHydros GET /nucleus/v1/client_hydro List all client-hydro relationships
atom_api.NucleusApi getClientPerformance GET /nucleus/v1/client/{client_id}/performance Get client performance
atom_api.NucleusApi getClientResponse GET /nucleus/v1/client_response/{client_response_id} Retrieve a client response
atom_api.NucleusApi getClientResponses GET /nucleus/v1/client_response List all client responses
atom_api.NucleusApi getClientTransactions GET /nucleus/v1/client/{client_id}/transaction List all client transactions
atom_api.NucleusApi getClients GET /nucleus/v1/client List all clients
atom_api.NucleusApi getDecisionTree GET /nucleus/v1/decision_tree/{decision_tree_id} Retrieve a decision tree
atom_api.NucleusApi getDecisionTrees GET /nucleus/v1/decision_tree List all decision trees
atom_api.NucleusApi getDepositRequest GET /nucleus/v1/deposit/{deposit_id} Retrieve a deposit request
atom_api.NucleusApi getDepositRequests GET /nucleus/v1/deposit List all deposit requests
atom_api.NucleusApi getFundingRequest GET /nucleus/v1/funding/{funding_id} Retrieve a funding request
atom_api.NucleusApi getFundingRequests GET /nucleus/v1/funding List all funding requests
atom_api.NucleusApi getGoal GET /nucleus/v1/goal/{goal_id} Retrieve a goal
atom_api.NucleusApi getGoalAssetSizes GET /nucleus/v1/goal/{goal_id}/asset_size List goal asset sizes
atom_api.NucleusApi getGoalHoldings GET /goal/{goal_id}/holding List goal holdings
atom_api.NucleusApi getGoalPerformance GET /nucleus/v1/goal/{goal_id}/performance Get goal performance
atom_api.NucleusApi getGoalTrackRecord GET /nucleus/v1/goal_track/{goal_track_id} Retrieve a goal track record
atom_api.NucleusApi getGoalTrackRecords GET /nucleus/v1/goal_track List all goal track records
atom_api.NucleusApi getGoalTransactions GET /nucleus/v1/goal/{goal_id}/transaction List goal transactions
atom_api.NucleusApi getGoals GET /nucleus/v1/goal List all goals
atom_api.NucleusApi getModel GET /nucleus/v1/model/{model_id} Retrieve a model
atom_api.NucleusApi getModelAssetSize GET /nucleus/v1/model_asset_size/{model_asset_size_id} Retrieve a model asset size
atom_api.NucleusApi getModelAssetSizes GET /nucleus/v1/model_asset_size List all model asset sizes
atom_api.NucleusApi getModelComment GET /nucleus/v1/model_comment/{model_comment_id} Retrieve a model commentary
atom_api.NucleusApi getModelComments GET /nucleus/v1/model_comment List all model commentary
atom_api.NucleusApi getModelHolding GET /nucleus/v1/model_holding/{model_holding_id} Retrieve a model holding
atom_api.NucleusApi getModelHoldings GET /nucleus/v1/model_holding List all model holdings
atom_api.NucleusApi getModelPerformance GET /nucleus/v1/model/{model_id}/performance Get model performance
atom_api.NucleusApi getModelTransaction GET /nucleus/v1/model_transaction/{model_transaction_id} Retrieve a model transaction
atom_api.NucleusApi getModelTransactions GET /nucleus/v1/model_transaction List all model transactions
atom_api.NucleusApi getModels GET /nucleus/v1/model List all models
atom_api.NucleusApi getNode GET /nucleus/v1/node/{node_id} Retrieve a node
atom_api.NucleusApi getNodeRelationship GET /nucleus/v1/node_relationship/{node_relationship_id} Retrieve a node relationship
atom_api.NucleusApi getNodeRelationships GET /nucleus/v1/node_relationship List all node relationships
atom_api.NucleusApi getNodes GET /nucleus/v1/node List all nodes
atom_api.NucleusApi getOrderRecord GET /nucleus/v1/order/{order_id} Retrieve an order record
atom_api.NucleusApi getOrderRecords GET /nucleus/v1/order List all order records
atom_api.NucleusApi getOrderStatus GET /nucleus/v1/order_status/{order_status_id} Retrieve an order status
atom_api.NucleusApi getOrderStatuses GET /nucleus/v1/order_status List all order statuses
atom_api.NucleusApi getOrderTrackingRecord GET /nucleus/v1/order_track/{order_track_id} Retrieve an order tracking record
atom_api.NucleusApi getOrderTrackingRecords GET /nucleus/v1/order_track List all order tracking records
atom_api.NucleusApi getPortfolio GET /nucleus/v1/portfolio/{portfolio_id} Retrieve a portfolio
atom_api.NucleusApi getPortfolioAssetSize GET /nucleus/v1/portfolio_asset_size/{portfolio_asset_size_id} Retrieve a portfolio asset size
atom_api.NucleusApi getPortfolioAssetSizes GET /nucleus/v1/portfolio_asset_size List all portfolio asset sizes
atom_api.NucleusApi getPortfolioComment GET /nucleus/v1/portfolio_comment/{portfolio_comment_id} Retrieve a portfolio commentary
atom_api.NucleusApi getPortfolioComments GET /nucleus/v1/portfolio_comment List all portfolio commentary
atom_api.NucleusApi getPortfolioHolding GET /nucleus/v1/portfolio_holding/{portfolio_holding_id} Retrieve a portfolio holding
atom_api.NucleusApi getPortfolioHoldings GET /nucleus/v1/portfolio_holding List all portfolio holdings
atom_api.NucleusApi getPortfolioPerformance GET /nucleus/v1/portfolio/{portfolio_id}/performance Get portfolio performance
atom_api.NucleusApi getPortfolioTransaction GET /nucleus/v1/portfolio_transaction/{portfolio_transaction_id} Retrieve a portfolio transaction
atom_api.NucleusApi getPortfolioTransactions GET /nucleus/v1/portfolio_transaction List all portfolio transactions
atom_api.NucleusApi getPortfolios GET /nucleus/v1/portfolio List all portfolios
atom_api.NucleusApi getQuestionnaire GET /nucleus/v1/questionnaire/{questionnaire_id} Retrieve a questionnaire
atom_api.NucleusApi getQuestionnaires GET /nucleus/v1/questionnaire List all questionnaires
atom_api.NucleusApi getScore GET /nucleus/v1/score/{score_id} Retrieve a score
atom_api.NucleusApi getScores GET /nucleus/v1/score List all scores
atom_api.NucleusApi getSecurities GET /nucleus/v1/security List all securities
atom_api.NucleusApi getSecurity GET /nucleus/v1/security/{security_id} Retrieve a security
atom_api.NucleusApi getSecurityExclusion GET /nucleus/v1/security_exclusion/{security_exclusion_id} Retrieve a security exclusion
atom_api.NucleusApi getSecurityExclusions GET /nucleus/v1/security_exclusion List all security exclusions
atom_api.NucleusApi getSecurityPerformance GET /nucleus/v1/security/{security_id}/performance Get security performance
atom_api.NucleusApi getSecurityPrice GET /nucleus/v1/security_price/{security_price_id} Retrieve a security price
atom_api.NucleusApi getSecurityPrices GET /nucleus/v1/security_price List all security prices
atom_api.NucleusApi getTransactionCode GET /nucleus/v1/transaction_code/{transaction_code_id} Retrieve a transaction code
atom_api.NucleusApi getTransactionCodes GET /nucleus/v1/transaction_code List all transaction codes
atom_api.NucleusApi getTransferRequest GET /nucleus/v1/transfer/{transfer_id} Retrieve a transfer request
atom_api.NucleusApi getTransferRequests GET /nucleus/v1/transfer List all transfer requests
atom_api.NucleusApi getWithdrawalRequest GET /nucleus/v1/withdrawal/{withdrawal_id} Retrieve a withdrawal request
atom_api.NucleusApi getWithdrawalRequests GET /nucleus/v1/withdrawal List all withdrawal requests
atom_api.NucleusApi postAccount POST /nucleus/v1/account Create an account under a client
atom_api.NucleusApi postAccountAllocation POST /nucleus/v1/account_allocation Create an account allocation
atom_api.NucleusApi postAccountBulkOrder POST /nucleus/v1/account/{account_id}/order_bulk Bulk orders for an account
atom_api.NucleusApi postAccountRebalanceBuyOnlyOrder POST /nucleus/v1/account/{account_id}/order_buy_only Create buy-only account rebalance orders
atom_api.NucleusApi postAccountRebalanceOrder POST /nucleus/v1/account/{account_id}/order_rebalance Create account rebalance orders
atom_api.NucleusApi postAccountRebalanceSellOnlyOrder POST /nucleus/v1/account/{account_id}/order_sell_only Create sell-only account rebalance orders
atom_api.NucleusApi postAccountSellAllOrder POST /nucleus/v1/account/{account_id}/order_sell_all Sell all account order
atom_api.NucleusApi postAccountStage POST /nucleus/v1/stage Create an account stage
atom_api.NucleusApi postAccountStatus POST /nucleus/v1/account_status Create an account status
atom_api.NucleusApi postAccountType POST /nucleus/v1/account_type Create an account type
atom_api.NucleusApi postAggregationAccount POST /nucleus/v1/aggregation_account Create an aggregation account
atom_api.NucleusApi postAggregationAccountBalance POST /nucleus/v1/aggregation_account_balance Create an aggregation account balance
atom_api.NucleusApi postAllocation POST /nucleus/v1/allocation Create an allocation
atom_api.NucleusApi postAllocationComposition POST /nucleus/v1/allocation_composition Create an allocation composition
atom_api.NucleusApi postBankLink POST /nucleus/v1/bank_link Create a bank link
atom_api.NucleusApi postBenchmark POST /nucleus/v1/benchmark Create a benchmark
atom_api.NucleusApi postBulkOrder POST /nucleus/v1/order_bulk Bulk orders for your firm
atom_api.NucleusApi postClient POST /nucleus/v1/client Create a client
atom_api.NucleusApi postClientBulkOrder POST /nucleus/v1/client/{client_id}/order_bulk Bulk orders for a client
atom_api.NucleusApi postClientHydro POST /nucleus/v1/client_hydro Create a client-hydro relationship
atom_api.NucleusApi postClientResponse POST /nucleus/v1/client_response Create a client response
atom_api.NucleusApi postDecisionTree POST /nucleus/v1/decision_tree Create a decision tree
atom_api.NucleusApi postDepositRequest POST /nucleus/v1/deposit Create a deposit request
atom_api.NucleusApi postFundingRequest POST /nucleus/v1/funding Create a funding request
atom_api.NucleusApi postGoal POST /nucleus/v1/goal Create a goal
atom_api.NucleusApi postGoalTrackRecord POST /nucleus/v1/goal_track Create a goal track record
atom_api.NucleusApi postModel POST /nucleus/v1/model Create a model
atom_api.NucleusApi postModelAssetSize POST /nucleus/v1/model_asset_size Create a model asset size
atom_api.NucleusApi postModelComment POST /nucleus/v1/model_comment Create a model commentary
atom_api.NucleusApi postModelHolding POST /nucleus/v1/model_holding Create a model holding
atom_api.NucleusApi postModelTransaction POST /nucleus/v1/model_transaction Create a model transaction
atom_api.NucleusApi postNode POST /nucleus/v1/node Create a node
atom_api.NucleusApi postNodeRelationship POST /nucleus/v1/node_relationship Create a node relationship
atom_api.NucleusApi postOrderRecord POST /nucleus/v1/order Create an order record
atom_api.NucleusApi postOrderStatus POST /nucleus/v1/order_status Create an order status
atom_api.NucleusApi postOrderTrackingRecord POST /nucleus/v1/order_track Create an order tracking record
atom_api.NucleusApi postPortfolio POST /nucleus/v1/portfolio Create a portfolio
atom_api.NucleusApi postPortfolioAssetSize POST /nucleus/v1/portfolio_asset_size Create a portfolio asset size
atom_api.NucleusApi postPortfolioComment POST /nucleus/v1/portfolio_comment Create a portfolio commentary
atom_api.NucleusApi postPortfolioHolding POST /nucleus/v1/portfolio_holding Create a portfolio holding
atom_api.NucleusApi postPortfolioRebalanceBuyOnlyOrder POST /nucleus/v1/portfolio/{portfolio_id}/order_buy_only Create buy-only portfolio rebalance orders
atom_api.NucleusApi postPortfolioRebalanceOrder POST /nucleus/v1/portfolio/{portfolio_id}/order_rebalance Create portfolio rebalance orders
atom_api.NucleusApi postPortfolioRebalanceSellOnlyOrder POST /nucleus/v1/portfolio/{portfolio_id}/order_sell_only Create sell-only portfolio rebalance orders
atom_api.NucleusApi postPortfolioSellAllOrder POST /nucleus/v1/portfolio/{portfolio_id}/order_sell_all Sell all portfolio order
atom_api.NucleusApi postPortfolioTransaction POST /nucleus/v1/portfolio_transaction Create a portfolio transaction
atom_api.NucleusApi postQuestionnaire POST /nucleus/v1/questionnaire Create a questionnaire
atom_api.NucleusApi postScore POST /nucleus/v1/score Create a score
atom_api.NucleusApi postSecurity POST /nucleus/v1/security Create a security
atom_api.NucleusApi postSecurityExclusion POST /nucleus/v1/security_exclusion Create a security exclusion
atom_api.NucleusApi postSecurityPrice POST /nucleus/v1/security_price Create a security price
atom_api.NucleusApi postTransactionCode POST /nucleus/v1/transaction_code Create a transaction code
atom_api.NucleusApi postTransferRequest POST /nucleus/v1/transfer Create a transfer request
atom_api.NucleusApi postWithdrawalRequest POST /nucleus/v1/withdrawal Create a withdrawal request
atom_api.NucleusApi subscribeAccount POST /nucleus/v1/account/{account_id}/subscribe Subscribe an account
atom_api.NucleusApi updateAccount PUT /nucleus/v1/account/{account_id}/ Update an account
atom_api.NucleusApi updateAccountAllocation PUT /nucleus/v1/account_allocation/{account_allocation_id} Update an account allocation
atom_api.NucleusApi updateAccountPermission PUT /nucleus/v1/account_permission/{account_id} Update an account's permissions
atom_api.NucleusApi updateAccountStage PUT /nucleus/v1/stage/{stage_id} Update an account stage
atom_api.NucleusApi updateAccountStatus PUT /nucleus/v1/account_status/{account_status_id} Update an account status
atom_api.NucleusApi updateAccountType PUT /nucleus/v1/account_type/{account_type_id} Update an account type
atom_api.NucleusApi updateAggregationAccount PUT /nucleus/v1/aggregation_account/{aggregation_account_id} Update an aggregation account
atom_api.NucleusApi updateAggregationAccountBalance PUT /nucleus/v1/aggregation_account_balance/{aggregation_account_balance_id} Update an aggregation account balance
atom_api.NucleusApi updateAllocation PUT /nucleus/v1/allocation/{allocation_id} Update an allocation
atom_api.NucleusApi updateAllocationComposition PUT /nucleus/v1/allocation_composition/{allocation_composition_id} Update an allocation composition
atom_api.NucleusApi updateBankLink PUT /nucleus/v1/bank_link/{bank_link_id} Update a bank link
atom_api.NucleusApi updateBenchmark PUT /nucleus/v1/benchmark/{benchmark_id} Update a benchmark
atom_api.NucleusApi updateClient PUT /nucleus/v1/client/{client_id} Update a client
atom_api.NucleusApi updateClientHydro PUT /nucleus/v1/client_hydro/{client_hydro_id} Update a client-hydro relationship
atom_api.NucleusApi updateClientResponse PUT /nucleus/v1/client_response/{client_response_id} Update a client response
atom_api.NucleusApi updateDecisionTree PUT /nucleus/v1/decision_tree/{decision_tree_id} Update a decision tree
atom_api.NucleusApi updateDepositRequest PUT /nucleus/v1/deposit/{deposit_id} Update a deposit request
atom_api.NucleusApi updateFundingRequest PUT /nucleus/v1/funding/{funding_id} Update a funding request
atom_api.NucleusApi updateGoal PUT /nucleus/v1/goal/{goal_id} Update a goal
atom_api.NucleusApi updateGoalTrackRecord PUT /nucleus/v1/goal_track/{goal_track_id} Update a goal track record
atom_api.NucleusApi updateModel PUT /nucleus/v1/model/{model_id} Update a model
atom_api.NucleusApi updateModelAssetSize PUT /nucleus/v1/model_asset_size/{model_asset_size_id} Update a model asset size
atom_api.NucleusApi updateModelComment PUT /nucleus/v1/model_comment/{model_comment_id} Update a model commentary
atom_api.NucleusApi updateModelComposition POST /nucleus/v1/model/{model_id}/model_change Change a model composition
atom_api.NucleusApi updateModelHolding PUT /nucleus/v1/model_holding/{model_holding_id} Update a model holding
atom_api.NucleusApi updateModelTransaction PUT /nucleus/v1/model_transaction/{model_transaction_id} Update a model transaction
atom_api.NucleusApi updateNode PUT /nucleus/v1/node/{node_id} Update a node
atom_api.NucleusApi updateNodeRelationship PUT /nucleus/v1/node_relationship/{node_relationship_id} Update a node relationship
atom_api.NucleusApi updateOrderRecord PUT /nucleus/v1/order/{order_id} Update an order record
atom_api.NucleusApi updateOrderStatus PUT /nucleus/v1/order_status/{order_status_id} Update an order status
atom_api.NucleusApi updateOrderTrackingRecord PUT /nucleus/v1/order_track/{order_track_id} Update an order tracking record
atom_api.NucleusApi updatePortfolio PUT /nucleus/v1/portfolio/{portfolio_id} Update a portfolio
atom_api.NucleusApi updatePortfolioAssetSize PUT /nucleus/v1/portfolio_asset_size/{portfolio_asset_size_id} Update a portfolio asset size
atom_api.NucleusApi updatePortfolioComment PUT /nucleus/v1/portfolio_comment/{portfolio_comment_id} Update a portfolio commentary
atom_api.NucleusApi updatePortfolioHolding PUT /nucleus/v1/portfolio_holding/{portfolio_holding_id} Update a portfolio holding
atom_api.NucleusApi updatePortfolioTransaction PUT /nucleus/v1/portfolio_transaction/{portfolio_transaction_id} Update a portfolio transaction
atom_api.NucleusApi updateQuestionnaire PUT /nucleus/v1/questionnaire/{questionnaire_id} Update a questionnaire
atom_api.NucleusApi updateScore PUT /nucleus/v1/score/{score_id} Update a score
atom_api.NucleusApi updateSecurity PUT /nucleus/v1/security/{security_id} Update a security
atom_api.NucleusApi updateSecurityExclusion PUT /nucleus/v1/security_exclusion/{security_exclusion_id} Update a security exclusion
atom_api.NucleusApi updateSecurityPrice PUT /nucleus/v1/security_price/{security_price_id} Update a security price
atom_api.NucleusApi updateTransactionCode PUT /nucleus/v1/transaction_code/{transaction_code_id} Update a transaction code
atom_api.NucleusApi updateTransferRequest PUT /nucleus/v1/transfer/{transfer_id} Update a transfer request
atom_api.NucleusApi updateWithdrawalRequest PUT /nucleus/v1/withdrawal/{withdrawal_id} Update a withdrawal request
atom_api.ProtonApi annuityCalculatorAccumulationHorizon POST /proton/v1/annuity_calculator/accumulation_horizon Annuity calculator - accumulation horizon
atom_api.ProtonApi annuityCalculatorAnnuityAmount POST /proton/v1/annuity_calculator/annuity_amount Annuity calculator - annuity amount
atom_api.ProtonApi annuityCalculatorDecumulationHorizon POST /proton/v1/annuity_calculator/decumulation_horizon Annuity calculator - decumulation horizon
atom_api.ProtonApi annuityCalculatorDepositAmount POST /proton/v1/annuity_calculator/deposit_amount Annuity calculator - deposit amount
atom_api.ProtonApi annuityCalculatorInitialBalance POST /proton/v1/annuity_calculator/initial_balance Annuity calculator - initial balance
atom_api.ProtonApi dimensionalRiskScore POST /proton/v1/dimensional_risk_score Dimensional risk score
atom_api.ProtonApi educationCalculatorAnnualCost POST /proton/v1/education_calculator/annual_cost Education calculator - total annual cost
atom_api.ProtonApi educationCalculatorDepositAmount POST /proton/v1/education_calculator/deposit_amount Education calculator - deposit amount
atom_api.ProtonApi educationCalculatorPercentCovered POST /proton/v1/education_calculator/percent_covered Education calculator - percent covered
atom_api.ProtonApi emergencyFundCalculator POST /proton/v1/emergency_fund_calculator Emergency fund calculator
atom_api.ProtonApi eventStudy POST /proton/v1/event_study Event study
atom_api.ProtonApi financialHealthCheck POST /proton/v1/financial_health_check Financial health check
atom_api.ProtonApi goalAccumulationAllocation POST /proton/v1/goal_accumulation/allocation Goal accumulation allocation
atom_api.ProtonApi goalAccumulationRecommendation POST /proton/v1/goal_accumulation/recommendation Goal accumulation recommendation
atom_api.ProtonApi goalAccumulationStatus POST /proton/v1/goal_accumulation/status Goal accumulation status
atom_api.ProtonApi goalDecumulationAllocation POST /proton/v1/goal_decumulation/allocation Goal decumulation allocation
atom_api.ProtonApi goalDecumulationRecommendation POST /proton/v1/goal_decumulation/recommendation Goal decumulation recommendation
atom_api.ProtonApi goalDecumulationStatus POST /proton/v1/goal_decumulation/status Goal decumulation status
atom_api.ProtonApi lifeInsuranceNeedsCalculator POST /proton/v1/life_insurance/needs_calculator Life insurance needs calculator
atom_api.ProtonApi modelBacktest POST /proton/v1/backtest Model backtest
atom_api.ProtonApi monteCarlo POST /proton/v1/monte_carlo Monte Carlo
atom_api.ProtonApi mortgageCalculatorDownPayment POST /proton/v1/mortgage_calculator/down_payment Mortgage calculator - down payment
atom_api.ProtonApi mortgageCalculatorHomePrice POST /proton/v1/mortgage_calculator/home_price Mortgage calculator - home price
atom_api.ProtonApi mortgageCalculatorPeriodicPayment POST /proton/v1/mortgage_calculator/periodic_payment Mortgage calculator - periodic payment
atom_api.ProtonApi mvo POST /proton/v1/mvo Mean-variance optimization
atom_api.ProtonApi portfolioDiversificationScore POST /proton/v1/diversification_score Portfolio diversification score
atom_api.ProtonApi portfolioOptimizationScore POST /proton/v1/portfolio_optimization_score Portfolio optimization score
atom_api.ProtonApi portfolioWhatIf POST /proton/v1/portfolio_what_if Portfolio what-if
atom_api.ProtonApi purchaseCalculatorDepositAmount POST /proton/v1/purchase_calculator/deposit_amount Purchase calculator - deposit amount
atom_api.ProtonApi purchaseCalculatorHorizon POST /proton/v1/purchase_calculator/horizon Purchase calculator - horizon
atom_api.ProtonApi purchaseCalculatorPurchaseAmount POST /proton/v1/purchase_calculator/amount Purchase calculator - purchase amount
atom_api.ProtonApi rebalancingSignal POST /proton/v1/rebalancing_signal Rebalancing
atom_api.ProtonApi retirementCalculatorDepositAmount POST /proton/v1/retirement_calculator/deposit_amount Retirement calculator - deposit amount
atom_api.ProtonApi retirementCalculatorExpenses POST /proton/v1/retirement_calculator/expenses Retirement calculator - expenses
atom_api.ProtonApi retirementCalculatorPercentCovered POST /proton/v1/retirement_calculator/percent_covered Retirement calculator - percent of costs covered
atom_api.ProtonApi riskAllocation POST /proton/v1/risk_allocation Risk allocation
atom_api.ProtonApi riskScore POST /proton/v1/risk_score Risk score
atom_api.ProtonApi savingsCalculator POST /proton/v1/savings_calculator Savings calculator
atom_api.ProtonApi scenarioAnalysis POST /proton/v1/scenario_analysis Scenario analysis
atom_api.ProtonApi sensitivityAnalysis 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.