Skip to content

Serverless APIs

Retired — not available on the v3 API

The endpoints on this page belonged to the legacy serverless surface, which is being retired. They are reached on the serverless host — https://tapi-sandboxdash.norcapsecurities.com/… (sandbox) or https://tapi.norcapsecurities.com/… (production) — with no /v3 path prefix. They are not served by the v3 API on the primary host — requests to these paths on https://api-sandboxdash.norcapsecurities.com/v3/… (sandbox) or https://api.norcapsecurities.com/v3/… (production) return 404, except getAccount, which resolves to the standard Accounts API getAccount and behaves differently from the legacy variant documented below. Do not build new integrations against them. This page is retained as a historical reference — each endpoint links to its recommended replacement.

Requests authenticated with clientID and developerAPIKey body parameters. The examples below read them from $TAPI_CLIENT_ID and $TAPI_API_KEY — see Running the Examples. They spell out their host, since it is the legacy serverless one rather than the $TAPI_HOST used everywhere else. These endpoints are retired; the examples are a record of the request shape and are not expected to succeed.

Base URL: https://tapi-sandboxdash.norcapsecurities.com. This is the legacy serverless host, not the $TAPI_HOST the rest of this documentation uses.

Endpoints

POST /getLinkedAccounts

Retired — not available on the v3 host

This endpoint does not exist on the v3 API; requests return 404. Use the v3 Links API instead — see GET /v3/links.

This API showed all accounts that are linked to the party id.

Parameters

Parameter Type Required Description
partyId string Yes Link party ID that is generated by the API once a link is created(createLink)

Example Request

curl -X POST https://tapi-sandboxdash.norcapsecurities.com/getLinkedAccounts \
  -d clientID="$TAPI_CLIENT_ID" \
  -d developerAPIKey="$TAPI_API_KEY" \
  -d partyId=P12345

Response

Field Type Description
linkDetails string Array of link includes all information of the matched link (linkId, firstEntryType, firstEntry, relatedEntryType, relatedEntry, linkType, notes)

Example Response

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "linkDetails": [
    {
      "linkId": "330",
      "firstEntryType": "Account",
      "firstEntry": "A51242",
      "relatedEntry": "P99324",
      "relatedEntryType": "IndivACParty",
      "linkType": "owner",
      "notes": ""
    }
  ]
}

POST /getAccount

Retired — legacy variant not available on the v3 host

The securityid-based lookup documented below does not exist on the v3 API. POST /v3/getAccount on the primary host is the standard Accounts API method, which takes accountId and returns accountDetails — see getAccount.

Parameters

Parameter Type Required Description
securityid string Yes Security ID

Example Request

curl -X POST https://tapi-sandboxdash.norcapsecurities.com/getAccount \
  -d clientID="$TAPI_CLIENT_ID" \
  -d developerAPIKey="$TAPI_API_KEY" \
  -d securityid=77654

Response

Field Type Description
tradeDetails string Array of trade details

Example Response

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "tradeDetails": [
    {
      "tradeId": "738346017",
      "askOrderId": "147017465",
      "bidOrderId": "879249632"
    }
  ]
}

POST /getTradeStatusesForOffering

Retired — not available on the v3 host

This endpoint does not exist on the v3 API; requests return 404. Use getTradesForOffering instead.

Returned an array of trade IDs and current trade statuses associated with a specific Offering ID.

Parameters

Parameter Type Required Description
offeringId string Yes Offering ID that is generated by the API when an offering is created (createOffering)
tradeStatus string No Trade Status (Filter): CREATED / FUNDED / UNWIND PENDING / UNWIND SETTLED / SETTLED / CANCELED

Example Request

curl -X POST https://tapi-sandboxdash.norcapsecurities.com/getTradeStatusesForOffering \
  -d clientID="$TAPI_CLIENT_ID" \
  -d developerAPIKey="$TAPI_API_KEY" \
  -d offeringId=8139 \
  -d tradeStatus=CREATED

Response

Field Type Description
Offering purchased details string Returns an array of offering trades history

Example Response

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "Offering purchased details": [
    {
      "tradeId": "114431043",
      "accountId": "A49501",
      "transactionType": "CreditCard",
      "totalShares": "800.000000",
      "unitPrice": "2.449500",
      "totalAmount": "1959.600000",
      "tradeStatus": "CREATED",
      "RRApprovalStatus": "Pending",
      "PrincipalApprovalStatus": "Pending",
      "field1": "",
      "field2": "",
      "field3": "",
      "esignStatus": "NOTSIGNED"
    }
  ]
}

POST /getApiCount

Retired — legacy host only, no /v3 prefix

getApiCount is reached on the legacy serverless host (https://tapi-sandboxdash.norcapsecurities.com in sandbox, https://tapi.norcapsecurities.com in production), without a /v3 path prefix. Requests to the primary host fail with a permission error. There is no v3 replacement.

This method will provide the API count for the current month (midnight UTC on the 1st to current day)

Example Request

curl -X POST https://tapi-sandboxdash.norcapsecurities.com/getApiCount \
  -d clientID="$TAPI_CLIENT_ID" \
  -d developerAPIKey="$TAPI_API_KEY"

Response

Field Type Description
APICountDetails object API count details (clientId, apiCount)
clientId string TransactAPI Client ID
apiCount string Total number of API calls for the current month, formatted with thousands separators

Example Response

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "APICountDetails": {
    "clientId": "someclientid",
    "apiCount": "1,058"
  }
}