Pulse Markets
Pulse Markets docsGet an instrument
Fetch one instrument by id. Returns 404 for an unknown id - never an invented instrument row.
Fetch one instrument by id. Returns 404 for an unknown id - never an invented instrument row.
Authorization
ApiKeyAuth instruments:readPresent your API key as a bearer token: Authorization: Bearer pk_live_....
Two environments are issued per account. A pk_test_ sandbox key returns the SAME real historical data as a live key and does NOT consume your LIVE allowance, so learning the API is free. It has its own separate windows and can be rate limited on them. A pk_live_ key reads against your allowance.
Keys carry explicit scopes (instruments:read, prices:read, actions:read, fx:read, earnings:read, options:read, news:read, sentiment:read, events:read, analytics:read, correlations:read, technicals:read, macro:read) and are enforced fail-closed, so a leaked key is bounded to what it was issued for. Revocation is immediate.
In: header
Scope: instruments:read
Path Parameters
Instrument identifier (UUID).
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/instruments/497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "assetClass": "equity", "displayName": "string", "exchange": "string", "region": "string", "isin": "string", "cusip": "string", "distributionPolicy": "accumulating", "quoteCurrency": "string", "quoteUnit": "string", "isActive": true, "currentSymbol": "string", "brokerCodes": { "property1": "string", "property2": "string" }, "fidelityCode": "string" }, "meta": { "asOf": "string", "source": "string", "stale": true }}{ "error": { "code": "invalid_request", "message": "string", "docsUrl": "http://example.com", "details": { "property1": [ "string" ], "property2": [ "string" ] } }}{ "error": { "code": "invalid_request", "message": "string", "docsUrl": "http://example.com", "details": { "property1": [ "string" ], "property2": [ "string" ] } }}{ "error": { "code": "invalid_request", "message": "string", "docsUrl": "http://example.com", "details": { "property1": [ "string" ], "property2": [ "string" ] } }}{ "error": { "code": "invalid_request", "message": "string", "docsUrl": "http://example.com", "details": { "property1": [ "string" ], "property2": [ "string" ] } }}{ "error": { "code": "invalid_request", "message": "string", "docsUrl": "http://example.com", "details": { "property1": [ "string" ], "property2": [ "string" ] } }}{ "error": { "code": "invalid_request", "message": "string", "docsUrl": "http://example.com", "details": { "property1": [ "string" ], "property2": [ "string" ] } }}Read implied volatility in bulk GET
Each requested instrument's most recent 30-day at-the-money implied volatility, annualised, as ONE read rather than one call per symbol. The thirty-day point rather than the front expiry, whose IV is dominated by whatever is happening this week and is therefore a poor measure of what the market expects over a holding period. Every row carries its own asOfDate: implied volatility is a statement about the NEXT thirty days, so a stale reading is not a slightly-worse answer, it is an answer to a different question. An instrument with no fresh snapshot is ABSENT from the result, never present with a zero, because a zero would be indistinguishable from a claim that the market prices this at no volatility.
List analyst rating-consensus snapshots GET
Sell-side analyst rating-consensus history for an instrument, newest first. The CHANGE across snapshots is the analyst-revision signal; counts are carried verbatim.