getOffering

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

Request Parameters

ParameterRequiredTypeDescription
clientIDyesstringTransactAPI Client ID
developerAPIKeyyesstringTransactAPI Developer Key
offeringIdyesstringOffering ID that is generated by the API when an Offering is created (createOffering)

Sample Request

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

ParameterTypeDescription
statusCodestringAPI Status Code
statusDescstringAPI Status Description
offeringDetailsstringDetails 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!

Language
Click Try It! to start a request and see the response here!