Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Scope Bid Exports API
version: 1.1.0
description: 'Operations tagged Exports across 2 of this provider''s published API definitions: scope-bid-openapi.json, scope-bid-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://scope.bid
description: Production
security:
- bearerAuth: []
tags:
- name: Exports
paths:
/api/v1/exports/ledes/{scope_id}:
get:
summary: LEDES 1998B billing export
description: 'Returns a pipe-delimited LEDES 1998B file. RBAC: export.run.'
parameters:
- name: scope_id
in: path
required: true
schema:
type: string
- name: start
in: query
schema:
type: string
format: date
- name: end
in: query
schema:
type: string
format: date
- name: format
in: query
schema:
type: string
enum:
- 1998B
default: 1998B
responses:
'200':
description: LEDES file.
content:
text/plain:
schema:
type: string
'403':
$ref: '#/components/responses/Forbidden'
'404':
description: Scope not found.
tags:
- Exports
operationId: getApiV1ExportsLedesByScopeId
x-operation-id-source: derived
servers:
- url: https://scope.bid
description: Production
/api/v1/exports/audit/{scopefile}:
get:
summary: Audit export (CSV or PDF)
description: The path is {scope_id}.csv or {scope_id}.pdf. Authorized by a carrier-feed token (query token) OR bearer/session with export.run.
parameters:
- name: scopefile
in: path
required: true
schema:
type: string
description: SC-XXXX.csv or SC-XXXX.pdf
- name: token
in: query
schema:
type: string
description: Carrier-feed token.
responses:
'200':
description: CSV or PDF audit report.
content:
text/csv:
schema:
type: string
application/pdf:
schema:
type: string
format: binary
'403':
description: Bad/expired/revoked token, or insufficient capability.
'404':
description: Scope not found.
tags:
- Exports
operationId: getApiV1ExportsAuditByScopefile
x-operation-id-source: derived
servers:
- url: https://scope.bid
description: Production
components:
responses:
Forbidden:
description: 'The caller is not authorized: the caller''s role does not grant the required capability, the partner token lacks the required scope, or the partner is not authorized to act for this firm.'
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: 'OAuth 2.0 access token, or a personal access token (PAT) for CI and power users. Pass as Authorization: Bearer <token>. Every token resolves to exactly one tenant.'
x-refined-from:
- scope-bid-openapi.json
- scope-bid-openapi.json