### Install Empirasign Python SDK from GitHub Source: https://github.com/empirasign/python-sdk/blob/master/README.md Install the Empirasign Python SDK directly from its GitHub repository using pip. Ensure you have obtained API credentials before installation. ```shell pip install git+https://github.com/empirasign/python-sdk.git ``` -------------------------------- ### Instantiate Market Data Client Source: https://github.com/empirasign/python-sdk/blob/master/README.md Use this snippet to create an instance of the MarketDataClient. Ensure you have your Empirasign API key and secret. ```python from empirasign import MarketDataClient api = MarketDataClient("Empirasign_Key", "Empirasign_Secret") ``` -------------------------------- ### Instantiate Parser Client Source: https://github.com/empirasign/python-sdk/blob/master/README.md Use this snippet to create an instance of the ParserClient. Ensure you have your Empirasign API key and secret. ```python from empirasign import ParserClient api = ParserClient("Empirasign_Key", "Empirasign_Secret") ``` -------------------------------- ### POST /mydata/ Source: https://github.com/empirasign/python-sdk/blob/master/README.md Retrieves user-specific data. This endpoint is associated with a class method for exporting MyData. ```APIDOC ## POST /mydata/ ### Description Retrieves user-specific data. This endpoint is associated with a class method for exporting MyData. ### Method POST ### Endpoint /mydata/ ### Quota Hit None ### Class Method `get_mydata` ``` -------------------------------- ### Market Data Endpoints Source: https://github.com/empirasign/python-sdk/blob/master/README.md This section details the available endpoints for fetching market data. Each endpoint is associated with a specific HTTP method, API path, and a corresponding class method in the SDK. ```APIDOC ## POST /bonds/ ### Description Retrieves market data for bonds. ### Method POST ### Endpoint /bonds/ ### Parameters #### Request Body - **bond_id** (string) - Required - The ID of the bond to retrieve market data for. ### Request Example ```json { "bond_id": "BOND123" } ``` ### Response #### Success Response (200) - **market_data** (object) - Description of the market data returned. #### Response Example ```json { "market_data": { "price": 100.50, "yield": 3.45 } } ``` ``` ```APIDOC ## GET /bwics/ ### Description Retrieves BWIC (Bid Wanted In Competition) data. ### Method GET ### Endpoint /bwics/ ### Response #### Success Response (200) - **bwics_data** (array) - A list of BWIC data entries. #### Response Example ```json { "bwics_data": [ { "id": "BWIC001", "description": "Some BWIC details" } ] } ``` ``` ```APIDOC ## POST /nport/ ### Description Retrieves NPORT data for bonds. ### Method POST ### Endpoint /nport/ ### Parameters #### Request Body - **bond_id** (string) - Required - The ID of the bond to retrieve NPORT data for. ### Request Example ```json { "bond_id": "BOND456" } ``` ### Response #### Success Response (200) - **nport_data** (object) - Description of the NPORT data returned. #### Response Example ```json { "nport_data": { "cusip": "123456789", "fund_name": "Example Fund" } } ``` ``` ```APIDOC ## GET /offers/ ### Description Retrieves available runs for offers. ### Method GET ### Endpoint /offers/ ### Response #### Success Response (200) - **offers** (array) - A list of available offer runs. #### Response Example ```json { "offers": [ { "run_id": "RUN001", "description": "Offer run details" } ] } ``` ``` ```APIDOC ## GET /offers/ ### Description Retrieves dealer runs for specific offers. ### Method GET ### Endpoint /offers/ ### Parameters #### Query Parameters - **offer_id** (string) - Required - The ID of the offer to retrieve dealer runs for. ### Response #### Success Response (200) - **dealer_runs** (array) - A list of dealer runs for the specified offer. #### Response Example ```json { "dealer_runs": [ { "dealer_id": "DEALER001", "price": 99.00 } ] } ``` ``` ```APIDOC ## GET /deal-classes/ ### Description Retrieves information about deal classes. ### Method GET ### Endpoint /deal-classes/ ### Response #### Success Response (200) - **deal_classes** (array) - A list of deal classes. #### Response Example ```json { "deal_classes": [ { "class_id": "CLASS001", "name": "Example Deal Class" } ] } ``` ``` ```APIDOC ## GET /all-bonds/ ### Description Retrieves a list of all active bonds. ### Method GET ### Endpoint /all-bonds/ ### Response #### Success Response (200) - **bonds** (array) - A list of active bonds. #### Response Example ```json { "bonds": [ { "bond_id": "BOND789", "description": "Active bond details" } ] } ``` ``` ```APIDOC ## POST /collab/ ### Description Retrieves suggested actions or data. ### Method POST ### Endpoint /collab/ ### Parameters #### Request Body - **query_params** (object) - Required - Parameters for the suggestion query. ### Request Example ```json { "query_params": { "type": "bond", "id": "BOND101" } } ``` ### Response #### Success Response (200) - **suggestions** (array) - A list of suggestions. #### Response Example ```json { "suggestions": [ { "action": "buy", "amount": 1000 } ] } ``` ``` ```APIDOC ## GET /mbsfeed/ ### Description Retrieves events from the MBS feed. ### Method GET ### Endpoint /mbsfeed/ ### Response #### Success Response (200) - **events** (array) - A list of MBS feed events. #### Response Example ```json { "events": [ { "event_id": "EVENT001", "type": "price_change" } ] } ``` ``` ```APIDOC ## GET /query-log/ ### Description Retrieves the query log. ### Method GET ### Endpoint /query-log/ ### Response #### Success Response (200) - **log_entries** (array) - A list of query log entries. #### Response Example ```json { "log_entries": [ { "timestamp": "2023-10-27T10:00:00Z", "query": "/all-bonds/" } ] } ``` ``` ```APIDOC ## GET /mystatus/ ### Description Retrieves the current status. ### Method GET ### Endpoint /mystatus/ ### Response #### Success Response (200) - **status** (string) - The current status. #### Response Example ```json { "status": "active" } ``` ``` ```APIDOC ## POST /corp-bonds/ ### Description Retrieves market data for corporate bonds. ### Method POST ### Endpoint /corp-bonds/ ### Parameters #### Request Body - **bond_id** (string) - Required - The ID of the corporate bond to retrieve market data for. - **page** (integer) - Optional - The page number for paginated results. ### Request Example ```json { "bond_id": "CORPBOND123", "page": 1 } ``` ### Response #### Success Response (200) - **market_data** (object) - Description of the market data returned. #### Response Example ```json { "market_data": { "price": 105.50, "yield": 4.10 } } ``` ``` ```APIDOC ## GET /corp-runs/ ### Description Retrieves available runs for corporate bond offers. ### Method GET ### Endpoint /corp-runs/ ### Response #### Success Response (200) - **corp_offers** (array) - A list of available corporate offer runs. #### Response Example ```json { "corp_offers": [ { "run_id": "CORPRUN001", "description": "Corporate offer run details" } ] } ``` ``` ```APIDOC ## GET /corp-runs/ ### Description Retrieves dealer runs for specific corporate bond offers. ### Method GET ### Endpoint /corp-runs/ ### Parameters #### Query Parameters - **offer_id** (string) - Required - The ID of the corporate offer to retrieve dealer runs for. - **page** (integer) - Optional - The page number for paginated results. ### Response #### Success Response (200) - **dealer_runs** (array) - A list of dealer runs for the specified corporate offer. #### Response Example ```json { "dealer_runs": [ { "dealer_id": "DEALER002", "price": 102.00 } ] } ``` ``` -------------------------------- ### POST /parse-run/, /parse-bwic/, /parse-corp/, /parse-loan/, /parse-cds/ Source: https://github.com/empirasign/python-sdk/blob/master/README.md Parses various types of documents including emails, BWIC, corporate, loan, and CDS data. This endpoint is associated with class methods for parsing different email formats. ```APIDOC ## POST /parse-run/, /parse-bwic/, /parse-corp/, /parse-loan/, /parse-cds/ ### Description Parses various types of documents including emails, BWIC, corporate, loan, and CDS data. This endpoint is associated with class methods for parsing different email formats. ### Method POST ### Endpoint /parse-run/ /parse-bwic/ /parse-corp/ /parse-loan/ /parse-cds/ ### Quota Hit 1 per request ### Class Method `parse_email_file` `parse_eml` `parse_msg` ``` -------------------------------- ### POST /submit-email/ Source: https://github.com/empirasign/python-sdk/blob/master/README.md Submits email data for processing. This endpoint is associated with class methods for submitting different email formats. ```APIDOC ## POST /submit-email/ ### Description Submits email data for processing. This endpoint is associated with class methods for submitting different email formats. ### Method POST ### Endpoint /submit-email/ ### Quota Hit None ### Class Method `submit_eml` `submit_msg` ``` -------------------------------- ### POST /id-mapper/ Source: https://github.com/empirasign/python-sdk/blob/master/README.md Maps common identifiers to bonds. This endpoint is used for retrieving ID mappings. ```APIDOC ## POST /id-mapper/ ### Description Maps common identifiers to bonds. This endpoint is used for retrieving ID mappings. ### Method POST ### Endpoint /id-mapper/ ### Quota Hit 1 per id ### Class Method `get_id_mapping` ``` -------------------------------- ### POST /raw-msg/{tx_id}/ Source: https://github.com/empirasign/python-sdk/blob/master/README.md Retrieves raw message data for a given transaction ID. This endpoint is associated with a class method for fetching raw messages. ```APIDOC ## POST /raw-msg/{tx_id}/ ### Description Retrieves raw message data for a given transaction ID. This endpoint is associated with a class method for fetching raw messages. ### Method POST ### Endpoint /raw-msg/{tx_id}/ ### Quota Hit None ### Class Method `get_raw_msg` ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.