coinbase-api 0.3.2 → 0.5.0

package/dist/mjs/types/request/advanced-trade-client.d.ts

@@ -0,0 +1,194 @@
+/**
+ *
+ * Account Endpoints
+ *
+ */
+import { OrderConfiguration } from '../shared.types.js';
+/**
+ *
+ * Products Endpoints
+ *
+ */
+export interface GetAdvTradeProductsRequest {
+    limit?: number;
+    offset?: number;
+    product_type?: 'UNKNOWN_PRODUCT_TYPE' | 'FUTURE' | 'SPOT';
+    product_ids?: string[];
+    contract_expiry_type?: 'UNKNOWN_CONTRACT_EXPIRY_TYPE' | 'PERPETUAL' | 'EXPIRING';
+    expiring_contract_status?: 'UNKNOWN_EXPIRING_CONTRACT_STATUS' | 'STATUS_UNEXPIRED' | 'STATUS_EXPIRED' | 'STATUS_ALL';
+    get_tradability_status?: boolean;
+    get_all_products?: boolean;
+}
+export interface GetAdvTradeProductCandlesRequest {
+    product_id: string;
+    start: string;
+    end: string;
+    granularity: 'UNKNOWN_GRANULARITY' | 'ONE_MINUTE' | 'FIVE_MINUTE' | 'FIFTEEN_MINUTE' | 'THIRTY_MINUTE' | 'ONE_HOUR' | 'TWO_HOUR' | 'SIX_HOUR' | 'ONE_DAY';
+    limit?: number;
+}
+export interface GetAdvTradeMarketTradesRequest {
+    product_id: string;
+    limit: number;
+    start?: string;
+    end?: string;
+}
+/**
+ *
+ * Orders Endpoints
+ *
+ */
+/**
+ * Note: client_order_id is optional, because the SDK will automatically generate a value for you during the request.
+ *
+ * If you are generating your own, make sure you either use the client.generateNewOrderId() method or make sure to prefix your value with "cbnode".
+ * The SDK will automatically add the prefix if the prefix is missing.
+ */
+export interface SubmitAdvTradeOrderRequest {
+    client_order_id?: string;
+    product_id: string;
+    side: 'BUY' | 'SELL';
+    order_configuration: OrderConfiguration;
+    leverage?: string;
+    margin_type?: 'CROSS' | 'ISOLATED';
+    retail_portfolio_id?: string;
+    preview_id?: string;
+}
+export interface GetAdvTradeOrdersRequest {
+    order_ids?: string[];
+    product_ids?: string[];
+    product_type?: 'UNKNOWN_PRODUCT_TYPE' | 'SPOT' | 'FUTURE';
+    order_status?: string[];
+    time_in_forces?: string[];
+    order_types?: string[];
+    order_side?: 'BUY' | 'SELL';
+    start_date?: string;
+    end_date?: string;
+    order_placement_source?: 'UNKNOWN_PLACEMENT_SOURCE' | 'RETAIL_SIMPLE' | 'RETAIL_ADVANCED';
+    contract_expiry_type?: 'UNKNOWN_CONTRACT_EXPIRY_TYPE' | 'PERPETUAL' | 'EXPIRING';
+    asset_filters?: string[];
+    retail_portfolio_id?: string;
+    limit?: number;
+    cursor?: string;
+    sort_by?: 'UNKNOWN_SORT_BY' | 'LIMIT_PRICE' | 'LAST_FILL_TIME';
+    user_native_currency?: string;
+}
+export interface GetAdvTradeFillsRequest {
+    order_ids?: string[];
+    trade_ids?: string[];
+    product_ids?: string[];
+    start_sequence_timestamp?: string;
+    end_sequence_timestamp?: string;
+    retail_portfolio_id?: string;
+    limit?: number;
+    cursor?: string;
+    sort_by?: 'UNKNOWN_SORT_BY' | 'PRICE' | 'TRADE_TIME';
+}
+export interface PreviewAdvTradeOrderRequest {
+    product_id: string;
+    side: 'BUY' | 'SELL';
+    order_configuration: OrderConfiguration;
+    leverage?: string;
+    margin_type?: 'ISOLATED' | 'CROSS';
+    retail_portfolio_id?: string;
+}
+/**
+ * Note: client_order_id is optional, because the SDK will automatically generate a value for you during the request.
+ *
+ * If you are generating your own, make sure you either use the client.generateNewOrderId() method or make sure to prefix your value with "cbnode".
+ * The SDK will automatically add the prefix if the prefix is missing.
+ */
+export interface CloseAdvTradePositionRequest {
+    client_order_id?: string;
+    product_id: string;
+    size?: string;
+}
+/**
+ *
+ * Portfolios Endpoints
+ *
+ */
+export interface MoveAdvTradePortfolioFundsRequest {
+    funds: {
+        value: string;
+        currency: string;
+    };
+    source_portfolio_uuid: string;
+    target_portfolio_uuid: string;
+}
+/**
+ *
+ * Futures Endpoints
+ *
+ */
+/**
+ *
+ * Perpetuals Endpoints
+ *
+ */
+export interface AllocateAdvTradePortfolioRequest {
+    portfolio_uuid: string;
+    symbol: string;
+    amount: string;
+    currency: string;
+}
+/**
+ *
+ * Fees Endpoints
+ *
+ */
+export interface GetAdvTradeTransactionSummaryRequest {
+    product_type?: 'UNKNOWN_PRODUCT_TYPE' | 'SPOT' | 'FUTURE';
+    contract_expiry_type?: 'UNKNOWN_CONTRACT_EXPIRY_TYPE' | 'SPOT' | 'FUTURE';
+    product_venue?: 'UNKNOWN_VENUE_TYPE' | 'CBE' | 'FCM' | 'INTX';
+}
+/**
+ *
+ * Converts Endpoints
+ *
+ */
+export interface SubmitAdvTradeConvertQuoteRequest {
+    from_account: string;
+    to_account: string;
+    amount: string;
+    trade_incentive_metadata?: {
+        user_incentive_id?: string;
+        code_val?: string;
+    };
+}
+/**
+ *
+ * Public Endpoints
+ *
+ */
+export interface GetAdvTradePublicProductsRequest {
+    limit?: number;
+    offset?: number;
+    product_type?: 'UNKNOWN_PRODUCT_TYPE' | 'SPOT' | 'FUTURE';
+    product_ids?: string[];
+    contract_expiry_type?: 'UNKNOWN_CONTRACT_EXPIRY_TYPE' | 'SPOT' | 'FUTURE';
+    expiring_contract_status?: 'UNKNOWN_EXPIRING_CONTRACT_STATUS' | 'STATUS_UNEXPIRED' | 'STATUS_EXPIRED' | 'STATUS_ALL';
+    get_all_products?: boolean;
+}
+export interface GetAdvTradePublicProductCandlesRequest {
+    product_id: string;
+    start: string;
+    end: string;
+    granularity: 'UNKNOWN_GRANULARITY' | 'ONE_MINUTE' | 'FIVE_MINUTE' | 'FIFTEEN_MINUTE' | 'THIRTY_MINUTE' | 'ONE_HOUR' | 'TWO_HOUR' | 'SIX_HOUR' | 'ONE_DAY';
+    limit?: number;
+}
+export interface GetAdvTradePublicMarketTradesRequest {
+    product_id: string;
+    limit: number;
+    start?: string;
+    end?: string;
+}
+/**
+ *
+ * Payment Methods Endpoints
+ *
+ */
+/**
+ *
+ * Data API Endpoints
+ *
+ */

package/dist/mjs/types/request/advanced-trade-client.js

@@ -0,0 +1,17 @@
+/**
+ *
+ * Account Endpoints
+ *
+ */
+export {};
+/**
+ *
+ * Payment Methods Endpoints
+ *
+ */
+/**
+ *
+ * Data API Endpoints
+ *
+ */
+//# sourceMappingURL=advanced-trade-client.js.map

package/dist/mjs/types/request/advanced-trade-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"advanced-trade-client.js","sourceRoot":"","sources":["../../../../src/types/request/advanced-trade-client.ts"],"names":[],"mappings":"AAAA;;;;GAIG;;AA8OH;;;;GAIG;AAEH;;;;GAIG"}

package/dist/mjs/types/request/coinbase-app-client.d.ts

@@ -0,0 +1,80 @@
+/**
+ *
+ * Account Endpoints
+ *
+ */
+/**
+ *
+ * Address Endpoints
+ *
+ */
+/**
+ *
+ * Transactions Endpoints
+ *
+ */
+export interface CBAppSendMoneyRequest {
+    account_id: string;
+    type: 'send';
+    to: string;
+    amount: string;
+    currency: string;
+    description?: string;
+    skip_notifications?: boolean;
+    idem?: string;
+    to_financial_institution?: boolean;
+    financial_institution_website?: string;
+    destination_tag?: string;
+}
+export interface CBAppTransferMoneyRequest {
+    account_id: string;
+    type: 'transfer';
+    to: string;
+    amount: string;
+    currency: string;
+    description?: string;
+}
+/**
+ *
+ * Deposits Endpoints
+ *
+ */
+export interface CBAppDepositFundsRequest {
+    account_id: string;
+    amount: string;
+    currency: string;
+    payment_method: string;
+    commit?: boolean;
+}
+/**
+ *
+ * Withdrawals Endpoints
+ *
+ */
+export interface CBAppWithdrawFundsRequest {
+    account_id: string;
+    amount: string;
+    currency: string;
+    payment_method: string;
+    commit?: boolean;
+}
+/**
+ *
+ * DATA - Currencies Endpoints
+ *
+ */
+/**
+ *
+ * DATA- Exchange rates Endpoints
+ *
+ */
+/**
+ *
+ * DATA - Prices Endpoints
+ *
+ */
+/**
+ *
+ * DATA - Time Endpoints
+ *
+ */

package/dist/mjs/types/request/coinbase-app-client.js

@@ -0,0 +1,27 @@
+/**
+ *
+ * Account Endpoints
+ *
+ */
+export {};
+/**
+ *
+ * DATA - Currencies Endpoints
+ *
+ */
+/**
+ *
+ * DATA- Exchange rates Endpoints
+ *
+ */
+/**
+ *
+ * DATA - Prices Endpoints
+ *
+ */
+/**
+ *
+ * DATA - Time Endpoints
+ *
+ */
+//# sourceMappingURL=coinbase-app-client.js.map

package/dist/mjs/types/request/coinbase-app-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"coinbase-app-client.js","sourceRoot":"","sources":["../../../../src/types/request/coinbase-app-client.ts"],"names":[],"mappings":"AAAA;;;;GAIG;;AAgEH;;;;GAIG;AAEH;;;;GAIG;AAEH;;;;GAIG;AAEH;;;;GAIG"}

package/dist/mjs/types/request/coinbase-exchange.d.ts

@@ -0,0 +1,332 @@
+/**
+ *
+ * Accounts Endpoints
+ *
+ */
+export interface GetCBExchAccountHoldsRequest {
+    account_id: string;
+    before?: string;
+    after?: string;
+    limit?: number;
+}
+export interface GetCBExchAccountLedgerRequest {
+    account_id: string;
+    start_date?: string;
+    end_date?: string;
+    before?: string;
+    after?: string;
+    limit?: number;
+    profile_id?: string;
+}
+export interface GetCBExchAccountTransfersRequest {
+    account_id: string;
+    before?: string;
+    after?: string;
+    limit?: number;
+    type?: string;
+}
+/**
+ *
+ * Address book Endpoints
+ *
+ */
+export interface GetCBExchAddressBookRequest {
+    addresses: {
+        currency: string;
+        to: {
+            address: string;
+            destination_tag?: string;
+        };
+        label?: string;
+        is_verified_self_hosted_wallet?: boolean;
+        vasp_id?: string;
+    }[];
+}
+/**
+ *
+ * Coinbase Account Endpoints
+ *
+ */
+export interface CreateCBExchNewCryptoAddress {
+    account_id: string;
+    profile_id?: string;
+    network?: string;
+}
+/**
+ *
+ * Conversions Endpoints
+ *
+ */
+export interface ConvertCBExchCurrencyRequest {
+    profile_id: string;
+    from: string;
+    to: string;
+    amount: string;
+    nonce: string;
+}
+/**
+ *
+ * Currencies Endpoints
+ *
+ */
+/**
+ *
+ * Transfers Endpoints
+ *
+ */
+export interface CBExchDepositFromCoinbaseAccount {
+    profile_id: string;
+    amount: string;
+    coinbase_account_id: string;
+    currency: string;
+}
+export interface CBExchDepositFromPaymentMethod {
+    profile_id: string;
+    amount: string;
+    payment_method_id: string;
+    currency: string;
+}
+export interface CBExchGetTransfersRequest {
+    profile_id?: string;
+    before?: string;
+    after?: string;
+    limit?: number;
+    type?: string;
+    currency_type?: string;
+    transfer_reason?: string;
+    currency?: string;
+}
+export interface SubmitCBExchTravelInformation {
+    transfer_id: string;
+    originator_name: string;
+    originator_country: string;
+}
+export interface CBExchWithdrawToCBAccount {
+    profile_id: string;
+    amount: string;
+    coinbase_account_id: string;
+    currency: string;
+}
+export interface CBExchWithdrawToCryptoAddress {
+    profile_id: string;
+    amount: string;
+    currency: string;
+    crypto_address: string;
+    destination_tag?: string;
+    no_destination_tag?: boolean;
+    nonce?: number;
+    network?: string;
+    add_network_fee_to_total?: boolean;
+    is_intermediary?: boolean;
+    intermediary_jurisdiction?: string;
+    travel_rule_data?: object;
+}
+export interface CBExchGetCryptoWithdrawalFeeEstimate {
+    currency: string;
+    crypto_address: string;
+    network?: string;
+}
+export interface CBExchWithdrawToPaymentMethod {
+    profile_id: string;
+    amount: string;
+    payment_method_id: string;
+    currency: string;
+}
+/**
+ *
+ * Fees Endpoints
+ *
+ */
+/**
+ *
+ * Orders Endpoints
+ *
+ */
+export interface GetCBExchFillsRequest {
+    order_id?: string;
+    product_id?: string;
+    limit?: number;
+    before?: string;
+    after?: string;
+    market_type?: string;
+    start_date?: string;
+    end_date?: string;
+}
+export interface GetCBExchOrdersRequest {
+    profile_id?: string;
+    product_id?: string;
+    sortedBy?: string;
+    sorting?: string;
+    start_date?: string;
+    end_date?: string;
+    before?: string;
+    after?: string;
+    limit: number;
+    status: string[];
+    market_type?: string;
+}
+export interface SubmitCBExchOrderRequest {
+    profile_id?: string;
+    type: string;
+    side: string;
+    product_id: string;
+    stp?: string;
+    stop?: string;
+    stop_price?: string;
+    price?: string;
+    size?: string;
+    funds?: string;
+    time_in_force?: string;
+    cancel_after?: string;
+    post_only?: boolean;
+    client_oid?: string;
+    max_floor?: string;
+    stop_limit_price?: string;
+}
+export interface CancelCBExchOrderRequest {
+    order_id: string;
+    profile_id?: string;
+    product_id?: string;
+}
+/**
+ *
+ * Loans Endpoints
+ *
+ */
+export interface SubmitCBExchNewLoan {
+    loan_id: string;
+    currency: string;
+    native_amount: string;
+    interest_rate: string;
+    term_start_date: string;
+    term_end_date: string;
+    profile_id: string;
+}
+export interface RepayCBExchLoanInterest {
+    idem: string;
+    from_profile_id: string;
+    currency: string;
+    native_amount: string;
+}
+export interface RepayCBExchLoanPrincipal {
+    loan_id: string;
+    idem: string;
+    from_profile_id: string;
+    currency: string;
+    native_amount: string;
+}
+export interface GetCBExchPrincipalRepaymentPreview {
+    loan_id: string;
+    currency: string;
+    native_amount: string;
+}
+/**
+ *
+ * Coinbase Price Oracle Endpoints
+ *
+ */
+/**
+ *
+ * Products Endpoints
+ *
+ */
+export interface GetCBExchProductCandles {
+    product_id: string;
+    granularity: number;
+    start?: string;
+    end?: string;
+}
+export interface GetCBExchProductTrades {
+    product_id: string;
+    limit?: number;
+    before?: string;
+    after?: string;
+}
+/**
+ *
+ * Profiles Endpoints
+ *
+ */
+export interface TransferCBExchFundsBetweenProfiles {
+    from: string;
+    to: string;
+    currency: string;
+    amount: string;
+}
+/**
+ *
+ * Reports Endpoints
+ *
+ */
+export interface GetAllCBExchReports {
+    profile_id?: string;
+    after?: string;
+    limit?: number;
+    type?: string;
+    ignore_expired?: boolean;
+}
+export interface CreateCBExchReport {
+    type: string;
+    year?: string;
+    format?: string;
+    email?: string;
+    profile_id?: string;
+    balance?: {
+        datetime?: string;
+        group_by_profile?: boolean;
+    };
+    fills?: {
+        start_date?: string;
+        end_date?: string;
+        product_id?: string;
+    };
+    account?: {
+        start_date?: string;
+        end_date?: string;
+        account_id?: string;
+    };
+    otc_fills?: {
+        start_date?: string;
+        end_date?: string;
+        product_id?: string;
+    };
+    tax_invoice?: {
+        start_date?: string;
+        end_date?: string;
+        product_id?: string;
+    };
+    rfq_fills?: {
+        start_date?: string;
+        end_date?: string;
+        product_id?: string;
+    };
+}
+/**
+ *
+ * Travel Rule Endpoints
+ *
+ */
+export interface GetCBExchTravelRuleInformation {
+    before?: string;
+    after?: string;
+    limit?: number;
+    address?: string;
+}
+/**
+ *
+ * Users Endpoints
+ *
+ */
+/**
+ *
+ * Wrapped Assets Endpoints
+ *
+ */
+export interface GetCBExchAllStakeWraps {
+    before?: string;
+    after?: string;
+    limit?: number;
+    from?: string;
+    to?: string;
+    status?: string;
+}

package/dist/mjs/types/request/coinbase-exchange.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=coinbase-exchange.js.map

package/dist/mjs/types/request/coinbase-exchange.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"coinbase-exchange.js","sourceRoot":"","sources":["../../../../src/types/request/coinbase-exchange.ts"],"names":[],"mappings":""}