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
gradle/wrapper Add SDKs Apr 9, 2019
src Add SDKs Apr 9, 2019
.gitignore 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
build.gradle Add SDKs Apr 9, 2019
build.sbt Add SDKs Apr 9, 2019
git_push.sh Add SDKs Apr 9, 2019
gradle.properties Add SDKs Apr 9, 2019
gradlew Add SDKs Apr 9, 2019
gradlew.bat Add SDKs Apr 9, 2019
pom.xml Add SDKs Apr 9, 2019
settings.gradle Add SDKs Apr 9, 2019

README.md

hydrogen-atom-api

Hydrogen Atom API

  • API version: 1.0.0
    • Build date: 2019-04-08T13:59:38.361-04:00

The Hydrogen Atom API

For more information, please visit https://www.hydrogenplatform.com/contact

Full documentation: Nucleus | Electron | Proton

Automatically generated by the Swagger Codegen

Requirements

Building the API client library requires:

  1. Java 1.7+
  2. Maven/Gradle

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>hydrogenplatform</groupId>
  <artifactId>hydrogen-atom-api</artifactId>
  <version>1.0.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "hydrogenplatform:hydrogen-atom-api:1.0.0"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/hydrogen-atom-api-1.0.0.jar
  • target/lib/*.jar

Getting Started

Full usage documentation is available: Nucleus | Electron | Proton

Please follow the installation instruction and execute the following Java code:

import atom_api.*;
import atom_api.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ElectronApi;

import java.io.File;
import java.util.*;

public class ElectronApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: oauth
        OAuth oauth = (OAuth) defaultClient.getAuthentication("oauth");
        // Method 1: Fetch and set access token with client_id and client_secret
        String token = oauth.fetchAccessToken("MYCLIENTID", "MYCLIENTSECRET");
        oauth.setAccessToken(token);
        // Method 2: Set access token using an existing token
        oauth.setAccessToken("MYACCESSTOKEN");

        ElectronApi apiInstance = new ElectronApi();
        UUID campaignId = new UUID(); // UUID | UUID of a marketing campaign
        try {
            apiInstance.deleteCampaign(campaignId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ElectronApi#deleteCampaign");
            e.printStackTrace();
        }
    }
}

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

Documentation for Models

Documentation for Authorization

Please see this page for additional authorization information.

Authentication schemes defined for the API:

oauth

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

https://www.hydrogenplatform.com/

You can’t perform that action at this time.