getOffering

POST https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/v3/getOffering

This method is used to get all the details of an offering. The Offering ID is required to get the information.

Request Parameters

Parameter	Required	Type	Description
clientID	yes	string	TransactAPI Client ID
developerAPIKey	yes	string	TransactAPI Developer Key
offeringId	yes	string	Offering ID that is generated by the API when an Offering is created (createOffering)

Sample Request

cURL

curl -k -X POST https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/v3/getOffering
-d developerAPIKey=somedeveloperkey
-d clientID=someclientid
-d offeringId=59249

Response Parameters

Parameter	Type	Description
statusCode	string	API Status Code
statusDesc	string	API Status Description
offeringDetails	string	Details of the matched offer trades amount as an array

Sample Response

{
    "statusCode": "101",
    "statusDesc": "Ok",
    "offeringDetails": [
        {
            "issuerId": "596423",
            "offeringId": "97618",
            "issueName": "Lauren Test Offering",
            "issueType": "Equity",
            "targetAmount": "37000.000000",
            "minAmount": "1.000000",
            "maxAmount": "37000.000000",
            "unitPrice": "1.000000",
            "totalShares": "37000.000000",
            "remainingShares": "14712.050946",
            "startDate": "02-11-2021",
            "endDate": "02-14-2022",
            "offeringStatus": "Pending",
            "offeringText": "Offering Text",
            "stampingText": "Watermark",
            "escrowAccountNumber": null,
            "field1": null,
            "field2": null,
            "field3": null
        }
    ]
}

Test it Yourself!