Syntax

Get equity by id

GET /v{version}/equities/{id}

This API endpoint enables you to retrieve detailed information about a specific equity by providing its internal identifier in AutoShares.

Type Name Description Schema Default

Type	Name	Description	Schema	Default
Header	Authorization required	This is the authorization token that you retrieved from the first endpoint (/token).	string
Path	id required	This is the internal identifier of the enquired equity in AutoShares.	integer (int32)
Path	version required	This is the version of the API. Unless you have multiple versions of AutoShares’s API deployed in your environment, leave it at 1.0.	string	`"1"`

Header

Authorization required

This is the authorization token that you retrieved from the first endpoint (/token).

string

Path

id required

This is the internal identifier of the enquired equity in AutoShares.

integer (int32)

Path

version required

This is the version of the API. Unless you have multiple versions of AutoShares’s API deployed in your environment, leave it at 1.0.

string

"1"

HTTP Code	Description	Schema
200	Successful request, JSON data containing detailed information about the enquired security is returned.	EquityResource
401	The access level of the provided authorization token is not sufficient to perform this operation.	No Content
404	Enquired security is non-existent in AutoShares.	No Content
422	A validation error occurred while processing the request.	No Content
500	Internal server error	No Content

HTTP Code

Description

Schema

200

Successful request, JSON data containing detailed information about the enquired security is returned.

401

The access level of the provided authorization token is not sufficient to perform this operation.

No Content

404

Enquired security is non-existent in AutoShares.

No Content

422

A validation error occurred while processing the request.

No Content

500

Internal server error

No Content

Last updated 10 days ago