searchOffering

This method is used to search all created offerings using a keyword and will return all matches for that keyword.

Request Parameters

Parameter	Required	Type	Description
clientID	yes	string	TransactAPI Client ID
developerAPIKey	yes	string	TransactAPI Developer Key
searchKeywork	yes	string	Keyword to search
issuerId	yes	integer	Issuer ID that is generated by the API when an Issuer is created (createIssuer)

Sample Request

cURL

curl -k -X POST https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/v3/searchOffering
-d developerAPIKey=somedeveloperkey
-d clientID=someclientid
-d searchKeyword=87982
-d issuerId=75509

Response Parameters

Parameter	Type	Description
statusCode	string	API Status Code
statusDesc	string	API Status Description
offeringDetails	string	Details of the matched offering as an array (issuerId, offeringId, issueName, issueType, targetAmount, minAmount, maxAmount, unitPrice, totalShares, remainingShares, startDate, endDate, offeringStatus, offeringText, stampingText)

Sample Response

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "offeringDetails": [
    {
      "issuerId": "75509",
      "offeringId": "87982",
      "issueName": "John Smith",
      "issueType": "equity",
      "targetAmount": "10000.000000",
      "minAmount": "11000.000000",
      "maxAmount": "12000.000000",
      "unitPrice": "100.000000",
      "totalShares": "120.000000",
      "remainingShares": "120.000000",
      "startDate": "02-02-2016",
      "endDate": "04-04-2016",
      "offeringStatus": "approved",
      "offeringText": "Offering Text Added",
      "stampingText": "Stamping Text Added"
    }
  ]
}

Test it Yourself!